Package v1api20240301 contains API Schema definitions for the app v1api20240301 API group
+string alias)| Value | +Description | +
|---|---|
"2024-03-01" |
++ |
+(Appears on:Google) +
+The configuration settings of the Allowed Audiences validation flow.
+| Field | +Description | +
|---|---|
+allowedAudiences+ +[]string + + |
+
+ AllowedAudiences: The configuration settings of the allowed list of audiences from which to validate the JWT token. + |
+
+(Appears on:Google_STATUS) +
+The configuration settings of the Allowed Audiences validation flow.
+| Field | +Description | +
|---|---|
+allowedAudiences+ +[]string + + |
+
+ AllowedAudiences: The configuration settings of the allowed list of audiences from which to validate the JWT token. + |
+
+(Appears on:DefaultAuthorizationPolicy) +
+The configuration settings of the Azure Active Directory allowed principals.
+| Field | +Description | +
|---|---|
+groups+ +[]string + + |
+
+ Groups: The list of the allowed groups. + |
+
+identities+ +[]string + + |
+
+ Identities: The list of the allowed identities. + |
+
+(Appears on:DefaultAuthorizationPolicy_STATUS) +
+The configuration settings of the Azure Active Directory allowed principals.
+| Field | +Description | +
|---|---|
+groups+ +[]string + + |
+
+ Groups: The list of the allowed groups. + |
+
+identities+ +[]string + + |
+
+ Identities: The list of the allowed identities. + |
+
+(Appears on:ManagedEnvironment_Spec) +
+Configuration of application logs
+| Field | +Description | +
|---|---|
+destination+ +string + + |
+
+ Destination: Logs destination, can be ‘log-analytics’, ‘azure-monitor’ or ‘none’ + |
+
+logAnalyticsConfiguration+ + +LogAnalyticsConfiguration + + + |
+
+ LogAnalyticsConfiguration: Log Analytics configuration, must only be provided when destination is configured as +‘log-analytics’ + |
+
+(Appears on:ManagedEnvironment_STATUS) +
+Configuration of application logs
+| Field | +Description | +
|---|---|
+destination+ +string + + |
+
+ Destination: Logs destination, can be ‘log-analytics’, ‘azure-monitor’ or ‘none’ + |
+
+logAnalyticsConfiguration+ + +LogAnalyticsConfiguration_STATUS + + + |
+
+ LogAnalyticsConfiguration: Log Analytics configuration, must only be provided when destination is configured as +‘log-analytics’ + |
+
+(Appears on:Facebook) +
+The configuration settings of the app registration for providers that have app ids and app secrets
+| Field | +Description | +
|---|---|
+appId+ +string + + |
+
+ AppId: The App ID of the app used for login. + |
+
+appSecretSettingName+ +string + + |
+
+ AppSecretSettingName: The app setting name that contains the app secret. + |
+
+(Appears on:Facebook_STATUS) +
+The configuration settings of the app registration for providers that have app ids and app secrets
+| Field | +Description | +
|---|---|
+appId+ +string + + |
+
+ AppId: The App ID of the app used for login. + |
+
+appSecretSettingName+ +string + + |
+
+ AppSecretSettingName: The app setting name that contains the app secret. + |
+
+(Appears on:IdentityProviders) +
+The configuration settings of the Apple provider.
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: |
+
+login+ + +LoginScopes + + + |
+
+ Login: The configuration settings of the login flow. + |
+
+registration+ + +AppleRegistration + + + |
+
+ Registration: The configuration settings of the Apple registration. + |
+
+(Appears on:Apple) +
+The configuration settings of the registration for the Apple provider
+| Field | +Description | +
|---|---|
+clientId+ +string + + |
+
+ ClientId: The Client ID of the app used for login. + |
+
+clientSecretSettingName+ +string + + |
+
+ ClientSecretSettingName: The app setting name that contains the client secret. + |
+
+(Appears on:Apple_STATUS) +
+The configuration settings of the registration for the Apple provider
+| Field | +Description | +
|---|---|
+clientId+ +string + + |
+
+ ClientId: The Client ID of the app used for login. + |
+
+clientSecretSettingName+ +string + + |
+
+ ClientSecretSettingName: The app setting name that contains the client secret. + |
+
+(Appears on:IdentityProviders_STATUS) +
+The configuration settings of the Apple provider.
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: |
+
+login+ + +LoginScopes_STATUS + + + |
+
+ Login: The configuration settings of the login flow. + |
+
+registration+ + +AppleRegistration_STATUS + + + |
+
+ Registration: The configuration settings of the Apple registration. + |
+
Generator information: +- Generated from: /app/resource-manager/Microsoft.App/stable/2024-03-01/AuthConfigs.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName}/authConfigs/{authConfigName} +
| Field | +Description | +||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||
+spec+ + +AuthConfig_Spec + + + |
+
+ + +
|
+||||||||||||||||||
+status+ + +AuthConfig_STATUS + + + |
++ | +
+(Appears on:AuthConfig_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:AuthConfig) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+encryptionSettings+ + +EncryptionSettings_STATUS + + + |
+
+ EncryptionSettings: The configuration settings of the secrets references of encryption key and signing key for +ContainerApp Service Authentication/Authorization. + |
+
+globalValidation+ + +GlobalValidation_STATUS + + + |
+
+ GlobalValidation: The configuration settings that determines the validation flow of users using Service +Authentication/Authorization. + |
+
+httpSettings+ + +HttpSettings_STATUS + + + |
+
+ HttpSettings: The configuration settings of the HTTP requests for authentication and authorization requests made against +ContainerApp Service Authentication/Authorization. + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} + |
+
+identityProviders+ + +IdentityProviders_STATUS + + + |
+
+ IdentityProviders: The configuration settings of each of the identity providers used to configure ContainerApp Service +Authentication/Authorization. + |
+
+login+ + +Login_STATUS + + + |
+
+ Login: The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization. + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+platform+ + +AuthPlatform_STATUS + + + |
+
+ Platform: The configuration settings of the platform of ContainerApp Service Authentication/Authorization. + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” + |
+
+(Appears on:AuthConfig) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+encryptionSettings+ + +EncryptionSettings + + + |
+
+ EncryptionSettings: The configuration settings of the secrets references of encryption key and signing key for +ContainerApp Service Authentication/Authorization. + |
+
+globalValidation+ + +GlobalValidation + + + |
+
+ GlobalValidation: The configuration settings that determines the validation flow of users using Service +Authentication/Authorization. + |
+
+httpSettings+ + +HttpSettings + + + |
+
+ HttpSettings: The configuration settings of the HTTP requests for authentication and authorization requests made against +ContainerApp Service Authentication/Authorization. + |
+
+identityProviders+ + +IdentityProviders + + + |
+
+ IdentityProviders: The configuration settings of each of the identity providers used to configure ContainerApp Service +Authentication/Authorization. + |
+
+login+ + +Login + + + |
+
+ Login: The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization. + |
+
+operatorSpec+ + +AuthConfigOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a app.azure.com/ContainerApp resource + |
+
+platform+ + +AuthPlatform + + + |
+
+ Platform: The configuration settings of the platform of ContainerApp Service Authentication/Authorization. + |
+
+(Appears on:AuthConfig_Spec) +
+The configuration settings of the platform of ContainerApp Service Authentication/Authorization.
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: |
+
+runtimeVersion+ +string + + |
+
+ RuntimeVersion: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. +The setting in this value can control the behavior of certain features in the Authentication / Authorization module. + |
+
+(Appears on:AuthConfig_STATUS) +
+The configuration settings of the platform of ContainerApp Service Authentication/Authorization.
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: |
+
+runtimeVersion+ +string + + |
+
+ RuntimeVersion: The RuntimeVersion of the Authentication / Authorization feature in use for the current app. +The setting in this value can control the behavior of certain features in the Authentication / Authorization module. + |
+
+(Appears on:IdentityProviders) +
+The configuration settings of the Azure Active directory provider.
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: |
+
+isAutoProvisioned+ +bool + + |
+
+ IsAutoProvisioned: Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party +tooling. +This is an internal flag primarily intended to support the Azure Management Portal. Users should not +read or write to this property. + |
+
+login+ + +AzureActiveDirectoryLogin + + + |
+
+ Login: The configuration settings of the Azure Active Directory login flow. + |
+
+registration+ + +AzureActiveDirectoryRegistration + + + |
+
+ Registration: The configuration settings of the Azure Active Directory app registration. + |
+
+validation+ + +AzureActiveDirectoryValidation + + + |
+
+ Validation: The configuration settings of the Azure Active Directory token validation flow. + |
+
+(Appears on:AzureActiveDirectory) +
+The configuration settings of the Azure Active Directory login flow.
+| Field | +Description | +
|---|---|
+disableWWWAuthenticate+ +bool + + |
+
+ DisableWWWAuthenticate: |
+
+loginParameters+ +[]string + + |
+
+ LoginParameters: Login parameters to send to the OpenID Connect authorization endpoint when +a user logs in. Each parameter must be in the form “key=value”. + |
+
+(Appears on:AzureActiveDirectory_STATUS) +
+The configuration settings of the Azure Active Directory login flow.
+| Field | +Description | +
|---|---|
+disableWWWAuthenticate+ +bool + + |
+
+ DisableWWWAuthenticate: |
+
+loginParameters+ +[]string + + |
+
+ LoginParameters: Login parameters to send to the OpenID Connect authorization endpoint when +a user logs in. Each parameter must be in the form “key=value”. + |
+
+(Appears on:AzureActiveDirectory) +
+The configuration settings of the Azure Active Directory app registration.
+| Field | +Description | +
|---|---|
+clientId+ +string + + |
+
+ ClientId: The Client ID of this relying party application, known as the client_id. +This setting is required for enabling OpenID Connection authentication with Azure Active Directory or +other 3rd party OpenID Connect providers. +More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html + |
+
+clientSecretCertificateIssuer+ +string + + |
+
+ ClientSecretCertificateIssuer: An alternative to the client secret thumbprint, that is the issuer of a certificate used +for signing purposes. This property acts as +a replacement for the Client Secret Certificate Thumbprint. It is also optional. + |
+
+clientSecretCertificateSubjectAlternativeName+ +string + + |
+
+ ClientSecretCertificateSubjectAlternativeName: An alternative to the client secret thumbprint, that is the subject +alternative name of a certificate used for signing purposes. This property acts as +a replacement for the Client Secret Certificate Thumbprint. It is also optional. + |
+
+clientSecretCertificateThumbprint+ +string + + |
+
+ ClientSecretCertificateThumbprint: An alternative to the client secret, that is the thumbprint of a certificate used for +signing purposes. This property acts as +a replacement for the Client Secret. It is also optional. + |
+
+clientSecretSettingName+ +string + + |
+
+ ClientSecretSettingName: The app setting name that contains the client secret of the relying party application. + |
+
+openIdIssuer+ +string + + |
+
+ OpenIdIssuer: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. +When using Azure Active Directory, this value is the URI of the directory tenant, e.g. +https://login.microsoftonline.com/v2.0/{tenant-guid}/. +This URI is a case-sensitive identifier for the token issuer. +More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html + |
+
+(Appears on:AzureActiveDirectory_STATUS) +
+The configuration settings of the Azure Active Directory app registration.
+| Field | +Description | +
|---|---|
+clientId+ +string + + |
+
+ ClientId: The Client ID of this relying party application, known as the client_id. +This setting is required for enabling OpenID Connection authentication with Azure Active Directory or +other 3rd party OpenID Connect providers. +More information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html + |
+
+clientSecretCertificateIssuer+ +string + + |
+
+ ClientSecretCertificateIssuer: An alternative to the client secret thumbprint, that is the issuer of a certificate used +for signing purposes. This property acts as +a replacement for the Client Secret Certificate Thumbprint. It is also optional. + |
+
+clientSecretCertificateSubjectAlternativeName+ +string + + |
+
+ ClientSecretCertificateSubjectAlternativeName: An alternative to the client secret thumbprint, that is the subject +alternative name of a certificate used for signing purposes. This property acts as +a replacement for the Client Secret Certificate Thumbprint. It is also optional. + |
+
+clientSecretCertificateThumbprint+ +string + + |
+
+ ClientSecretCertificateThumbprint: An alternative to the client secret, that is the thumbprint of a certificate used for +signing purposes. This property acts as +a replacement for the Client Secret. It is also optional. + |
+
+clientSecretSettingName+ +string + + |
+
+ ClientSecretSettingName: The app setting name that contains the client secret of the relying party application. + |
+
+openIdIssuer+ +string + + |
+
+ OpenIdIssuer: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application. +When using Azure Active Directory, this value is the URI of the directory tenant, e.g. +https://login.microsoftonline.com/v2.0/{tenant-guid}/. +This URI is a case-sensitive identifier for the token issuer. +More information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html + |
+
+(Appears on:AzureActiveDirectory) +
+The configuration settings of the Azure Active Directory token validation flow.
+| Field | +Description | +
|---|---|
+allowedAudiences+ +[]string + + |
+
+ AllowedAudiences: The list of audiences that can make successful authentication/authorization requests. + |
+
+defaultAuthorizationPolicy+ + +DefaultAuthorizationPolicy + + + |
+
+ DefaultAuthorizationPolicy: The configuration settings of the default authorization policy. + |
+
+jwtClaimChecks+ + +JwtClaimChecks + + + |
+
+ JwtClaimChecks: The configuration settings of the checks that should be made while validating the JWT Claims. + |
+
+(Appears on:AzureActiveDirectory_STATUS) +
+The configuration settings of the Azure Active Directory token validation flow.
+| Field | +Description | +
|---|---|
+allowedAudiences+ +[]string + + |
+
+ AllowedAudiences: The list of audiences that can make successful authentication/authorization requests. + |
+
+defaultAuthorizationPolicy+ + +DefaultAuthorizationPolicy_STATUS + + + |
+
+ DefaultAuthorizationPolicy: The configuration settings of the default authorization policy. + |
+
+jwtClaimChecks+ + +JwtClaimChecks_STATUS + + + |
+
+ JwtClaimChecks: The configuration settings of the checks that should be made while validating the JWT Claims. + |
+
+(Appears on:IdentityProviders_STATUS) +
+The configuration settings of the Azure Active directory provider.
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: |
+
+isAutoProvisioned+ +bool + + |
+
+ IsAutoProvisioned: Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party +tooling. +This is an internal flag primarily intended to support the Azure Management Portal. Users should not +read or write to this property. + |
+
+login+ + +AzureActiveDirectoryLogin_STATUS + + + |
+
+ Login: The configuration settings of the Azure Active Directory login flow. + |
+
+registration+ + +AzureActiveDirectoryRegistration_STATUS + + + |
+
+ Registration: The configuration settings of the Azure Active Directory app registration. + |
+
+validation+ + +AzureActiveDirectoryValidation_STATUS + + + |
+
+ Validation: The configuration settings of the Azure Active Directory token validation flow. + |
+
+(Appears on:IdentityProviders) +
+The configuration settings of the Azure Static Web Apps provider.
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: |
+
+registration+ + +AzureStaticWebAppsRegistration + + + |
+
+ Registration: The configuration settings of the Azure Static Web Apps registration. + |
+
+(Appears on:AzureStaticWebApps) +
+The configuration settings of the registration for the Azure Static Web Apps provider
+| Field | +Description | +
|---|---|
+clientId+ +string + + |
+
+ ClientId: The Client ID of the app used for login. + |
+
+(Appears on:AzureStaticWebApps_STATUS) +
+The configuration settings of the registration for the Azure Static Web Apps provider
+| Field | +Description | +
|---|---|
+clientId+ +string + + |
+
+ ClientId: The Client ID of the app used for login. + |
+
+(Appears on:IdentityProviders_STATUS) +
+The configuration settings of the Azure Static Web Apps provider.
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: |
+
+registration+ + +AzureStaticWebAppsRegistration_STATUS + + + |
+
+ Registration: The configuration settings of the Azure Static Web Apps registration. + |
+
+(Appears on:JobTemplate, Template) +
+Container App base container definition.
+| Field | +Description | +
|---|---|
+args+ +[]string + + |
+
+ Args: Container start command arguments. + |
+
+command+ +[]string + + |
+
+ Command: Container start command. + |
+
+env+ + +[]EnvironmentVar + + + |
+
+ Env: Container environment variables. + |
+
+image+ +string + + |
+
+ Image: Container image tag. + |
+
+name+ +string + + |
+
+ Name: Custom container name. + |
+
+resources+ + +ContainerResources + + + |
+
+ Resources: Container resource requirements. + |
+
+volumeMounts+ + +[]VolumeMount + + + |
+
+ VolumeMounts: Container volume mounts. + |
+
+(Appears on:JobTemplate_STATUS, Template_STATUS) +
+Container App base container definition.
+| Field | +Description | +
|---|---|
+args+ +[]string + + |
+
+ Args: Container start command arguments. + |
+
+command+ +[]string + + |
+
+ Command: Container start command. + |
+
+env+ + +[]EnvironmentVar_STATUS + + + |
+
+ Env: Container environment variables. + |
+
+image+ +string + + |
+
+ Image: Container image tag. + |
+
+name+ +string + + |
+
+ Name: Custom container name. + |
+
+resources+ + +ContainerResources_STATUS + + + |
+
+ Resources: Container resource requirements. + |
+
+volumeMounts+ + +[]VolumeMount_STATUS + + + |
+
+ VolumeMounts: Container volume mounts. + |
+
+(Appears on:TokenStore) +
+The configuration settings of the storage of the tokens if blob storage is used.
+| Field | +Description | +
|---|---|
+sasUrlSettingName+ +string + + |
+
+ SasUrlSettingName: The name of the app secrets containing the SAS URL of the blob storage containing the tokens. + |
+
+(Appears on:TokenStore_STATUS) +
+The configuration settings of the storage of the tokens if blob storage is used.
+| Field | +Description | +
|---|---|
+sasUrlSettingName+ +string + + |
+
+ SasUrlSettingName: The name of the app secrets containing the SAS URL of the blob storage containing the tokens. + |
+
+(Appears on:GitHub, Google) +
+The configuration settings of the app registration for providers that have client ids and client secrets
+| Field | +Description | +
|---|---|
+clientId+ +string + + |
+
+ ClientId: The Client ID of the app used for login. + |
+
+clientSecretSettingName+ +string + + |
+
+ ClientSecretSettingName: The app setting name that contains the client secret. + |
+
+(Appears on:GitHub_STATUS, Google_STATUS) +
+The configuration settings of the app registration for providers that have client ids and client secrets
+| Field | +Description | +
|---|---|
+clientId+ +string + + |
+
+ ClientId: The Client ID of the app used for login. + |
+
+clientSecretSettingName+ +string + + |
+
+ ClientSecretSettingName: The app setting name that contains the client secret. + |
+
+(Appears on:ContainerApp_Spec) +
+Non versioned Container App configuration properties that define the mutable settings of a Container app
+| Field | +Description | +
|---|---|
+activeRevisionsMode+ + +Configuration_ActiveRevisionsMode + + + |
+
+ ActiveRevisionsMode: ActiveRevisionsMode controls how active revisions are handled for the Container app:
+ |
+
+dapr+ + +Dapr + + + |
+
+ Dapr: Dapr configuration for the Container App. + |
+
+ingress+ + +Ingress + + + |
+
+ Ingress: Ingress configurations. + |
+
+maxInactiveRevisions+ +int + + |
+
+ MaxInactiveRevisions: Optional. Max inactive revisions a Container App can have. + |
+
+registries+ + +[]RegistryCredentials + + + |
+
+ Registries: Collection of private container registry credentials for containers used by the Container app + |
+
+secrets+ + +[]Secret + + + |
+
+ Secrets: Collection of secrets used by a Container app + |
+
+service+ + +Service + + + |
+
+ Service: Container App to be a dev Container App Service + |
+
string alias)+(Appears on:Configuration) +
+| Value | +Description | +
|---|---|
"Multiple" |
++ |
"Single" |
++ |
string alias)+(Appears on:Configuration_STATUS) +
+| Value | +Description | +
|---|---|
"Multiple" |
++ |
"Single" |
++ |
+(Appears on:ContainerApp_STATUS) +
+Non versioned Container App configuration properties that define the mutable settings of a Container app
+| Field | +Description | +
|---|---|
+activeRevisionsMode+ + +Configuration_ActiveRevisionsMode_STATUS + + + |
+
+ ActiveRevisionsMode: ActiveRevisionsMode controls how active revisions are handled for the Container app:
+ |
+
+dapr+ + +Dapr_STATUS + + + |
+
+ Dapr: Dapr configuration for the Container App. + |
+
+ingress+ + +Ingress_STATUS + + + |
+
+ Ingress: Ingress configurations. + |
+
+maxInactiveRevisions+ +int + + |
+
+ MaxInactiveRevisions: Optional. Max inactive revisions a Container App can have. + |
+
+registries+ + +[]RegistryCredentials_STATUS + + + |
+
+ Registries: Collection of private container registry credentials for containers used by the Container app + |
+
+secrets+ + +[]Secret_STATUS + + + |
+
+ Secrets: Collection of secrets used by a Container app + |
+
+service+ + +Service_STATUS + + + |
+
+ Service: Container App to be a dev Container App Service + |
+
+(Appears on:JobTemplate, Template) +
+Container App container definition
+| Field | +Description | +
|---|---|
+args+ +[]string + + |
+
+ Args: Container start command arguments. + |
+
+command+ +[]string + + |
+
+ Command: Container start command. + |
+
+env+ + +[]EnvironmentVar + + + |
+
+ Env: Container environment variables. + |
+
+image+ +string + + |
+
+ Image: Container image tag. + |
+
+name+ +string + + |
+
+ Name: Custom container name. + |
+
+probes+ + +[]ContainerAppProbe + + + |
+
+ Probes: List of probes for the container. + |
+
+resources+ + +ContainerResources + + + |
+
+ Resources: Container resource requirements. + |
+
+volumeMounts+ + +[]VolumeMount + + + |
+
+ VolumeMounts: Container volume mounts. + |
+
Generator information: +- Generated from: /app/resource-manager/Microsoft.App/stable/2024-03-01/ContainerApps.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/containerApps/{containerAppName} +
| Field | +Description | +||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||||||||
+spec+ + +ContainerApp_Spec + + + |
+
+ + +
|
+||||||||||||||||||||||||||
+status+ + +ContainerApp_STATUS + + + |
++ | +
+(Appears on:ContainerAppOperatorSpec) +
+| Field | +Description | +
|---|---|
+eventStreamEndpoint+ + +genruntime.ConfigMapDestination + + + |
+
+ EventStreamEndpoint: indicates where the EventStreamEndpoint config map should be placed. If omitted, no config map will +be created. + |
+
+fqdn+ + +genruntime.ConfigMapDestination + + + |
+
+ Fqdn: indicates where the Fqdn config map should be placed. If omitted, no config map will be created. + |
+
+(Appears on:ContainerApp_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+configMaps+ + +ContainerAppOperatorConfigMaps + + + |
+
+ ConfigMaps: configures where to place operator written ConfigMaps. + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:Container) +
+Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive +traffic.
+| Field | +Description | +
|---|---|
+failureThreshold+ +int + + |
+
+ FailureThreshold: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to +3. Minimum value is 1. Maximum value is 10. + |
+
+httpGet+ + +ContainerAppProbe_HttpGet + + + |
+
+ HttpGet: HTTPGet specifies the http request to perform. + |
+
+initialDelaySeconds+ +int + + |
+
+ InitialDelaySeconds: Number of seconds after the container has started before liveness probes are initiated. Minimum +value is 1. Maximum value is 60. + |
+
+periodSeconds+ +int + + |
+
+ PeriodSeconds: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is +240. + |
+
+successThreshold+ +int + + |
+
+ SuccessThreshold: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults +to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10. + |
+
+tcpSocket+ + +ContainerAppProbe_TcpSocket + + + |
+
+ TcpSocket: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. + |
+
+terminationGracePeriodSeconds+ +int + + |
+
+ TerminationGracePeriodSeconds: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. +The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the +time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for +your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value +overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop +immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling +ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour) + |
+
+timeoutSeconds+ +int + + |
+
+ TimeoutSeconds: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum +value is 240. + |
+
+type+ + +ContainerAppProbe_Type + + + |
+
+ Type: The type of probe. + |
+
+(Appears on:ContainerAppProbe) +
+| Field | +Description | +
|---|---|
+host+ +string + + |
+
+ Host: Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead. + |
+
+httpHeaders+ + +[]ContainerAppProbe_HttpGet_HttpHeaders + + + |
+
+ HttpHeaders: Custom headers to set in the request. HTTP allows repeated headers. + |
+
+path+ +string + + |
+
+ Path: Path to access on the HTTP server. + |
+
+port+ +int + + |
+
+ Port: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an +IANA_SVC_NAME. + |
+
+scheme+ + +ContainerAppProbe_HttpGet_Scheme + + + |
+
+ Scheme: Scheme to use for connecting to the host. Defaults to HTTP. + |
+
+(Appears on:ContainerAppProbe_HttpGet) +
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: The header field name + |
+
+value+ +string + + |
+
+ Value: The header field value + |
+
+(Appears on:ContainerAppProbe_HttpGet_STATUS) +
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: The header field name + |
+
+value+ +string + + |
+
+ Value: The header field value + |
+
+(Appears on:ContainerAppProbe_STATUS) +
+| Field | +Description | +
|---|---|
+host+ +string + + |
+
+ Host: Host name to connect to, defaults to the pod IP. You probably want to set “Host” in httpHeaders instead. + |
+
+httpHeaders+ + +[]ContainerAppProbe_HttpGet_HttpHeaders_STATUS + + + |
+
+ HttpHeaders: Custom headers to set in the request. HTTP allows repeated headers. + |
+
+path+ +string + + |
+
+ Path: Path to access on the HTTP server. + |
+
+port+ +int + + |
+
+ Port: Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an +IANA_SVC_NAME. + |
+
+scheme+ + +ContainerAppProbe_HttpGet_Scheme_STATUS + + + |
+
+ Scheme: Scheme to use for connecting to the host. Defaults to HTTP. + |
+
string alias)+(Appears on:ContainerAppProbe_HttpGet) +
+| Value | +Description | +
|---|---|
"HTTP" |
++ |
"HTTPS" |
++ |
string alias)+(Appears on:ContainerAppProbe_HttpGet_STATUS) +
+| Value | +Description | +
|---|---|
"HTTP" |
++ |
"HTTPS" |
++ |
+(Appears on:Container_STATUS) +
+Probe describes a health check to be performed against a container to determine whether it is alive or ready to receive +traffic.
+| Field | +Description | +
|---|---|
+failureThreshold+ +int + + |
+
+ FailureThreshold: Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to +3. Minimum value is 1. Maximum value is 10. + |
+
+httpGet+ + +ContainerAppProbe_HttpGet_STATUS + + + |
+
+ HttpGet: HTTPGet specifies the http request to perform. + |
+
+initialDelaySeconds+ +int + + |
+
+ InitialDelaySeconds: Number of seconds after the container has started before liveness probes are initiated. Minimum +value is 1. Maximum value is 60. + |
+
+periodSeconds+ +int + + |
+
+ PeriodSeconds: How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is +240. + |
+
+successThreshold+ +int + + |
+
+ SuccessThreshold: Minimum consecutive successes for the probe to be considered successful after having failed. Defaults +to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10. + |
+
+tcpSocket+ + +ContainerAppProbe_TcpSocket_STATUS + + + |
+
+ TcpSocket: TCPSocket specifies an action involving a TCP port. TCP hooks not yet supported. + |
+
+terminationGracePeriodSeconds+ +int + + |
+
+ TerminationGracePeriodSeconds: Optional duration in seconds the pod needs to terminate gracefully upon probe failure. +The grace period is the duration in seconds after the processes running in the pod are sent a termination signal and the +time when the processes are forcibly halted with a kill signal. Set this value longer than the expected cleanup time for +your process. If this value is nil, the pod’s terminationGracePeriodSeconds will be used. Otherwise, this value +overrides the value provided by the pod spec. Value must be non-negative integer. The value zero indicates stop +immediately via the kill signal (no opportunity to shut down). This is an alpha field and requires enabling +ProbeTerminationGracePeriod feature gate. Maximum value is 3600 seconds (1 hour) + |
+
+timeoutSeconds+ +int + + |
+
+ TimeoutSeconds: Number of seconds after which the probe times out. Defaults to 1 second. Minimum value is 1. Maximum +value is 240. + |
+
+type+ + +ContainerAppProbe_Type_STATUS + + + |
+
+ Type: The type of probe. + |
+
+(Appears on:ContainerAppProbe) +
+| Field | +Description | +
|---|---|
+host+ +string + + |
+
+ Host: Optional: Host name to connect to, defaults to the pod IP. + |
+
+port+ +int + + |
+
+ Port: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an +IANA_SVC_NAME. + |
+
+(Appears on:ContainerAppProbe_STATUS) +
+| Field | +Description | +
|---|---|
+host+ +string + + |
+
+ Host: Optional: Host name to connect to, defaults to the pod IP. + |
+
+port+ +int + + |
+
+ Port: Number or name of the port to access on the container. Number must be in the range 1 to 65535. Name must be an +IANA_SVC_NAME. + |
+
string alias)+(Appears on:ContainerAppProbe) +
+| Value | +Description | +
|---|---|
"Liveness" |
++ |
"Readiness" |
++ |
"Startup" |
++ |
string alias)+(Appears on:ContainerAppProbe_STATUS) +
+| Value | +Description | +
|---|---|
"Liveness" |
++ |
"Readiness" |
++ |
"Startup" |
++ |
string alias)+(Appears on:ContainerApp_STATUS) +
+| Value | +Description | +
|---|---|
"Canceled" |
++ |
"Deleting" |
++ |
"Failed" |
++ |
"InProgress" |
++ |
"Succeeded" |
++ |
+(Appears on:ContainerApp) +
+Container App.
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+configuration+ + +Configuration_STATUS + + + |
+
+ Configuration: Non versioned Container App configuration properties. + |
+
+customDomainVerificationId+ +string + + |
+
+ CustomDomainVerificationId: Id used to verify domain name ownership + |
+
+environmentId+ +string + + |
+
+ EnvironmentId: Resource ID of environment. + |
+
+eventStreamEndpoint+ +string + + |
+
+ EventStreamEndpoint: The endpoint of the eventstream of the container app. + |
+
+extendedLocation+ + +ExtendedLocation_STATUS + + + |
+
+ ExtendedLocation: The complex type of the extended location. + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} + |
+
+identity+ + +ManagedServiceIdentity_STATUS + + + |
+
+ Identity: managed identities for the Container App to interact with other Azure services without maintaining any secrets +or credentials in code. + |
+
+latestReadyRevisionName+ +string + + |
+
+ LatestReadyRevisionName: Name of the latest ready revision of the Container App. + |
+
+latestRevisionFqdn+ +string + + |
+
+ LatestRevisionFqdn: Fully Qualified Domain Name of the latest revision of the Container App. + |
+
+latestRevisionName+ +string + + |
+
+ LatestRevisionName: Name of the latest revision of the Container App. + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+managedBy+ +string + + |
+
+ ManagedBy: The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is +managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is +removed from the template since it is managed by another resource. + |
+
+managedEnvironmentId+ +string + + |
+
+ ManagedEnvironmentId: Deprecated. Resource ID of the Container App’s environment. + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+outboundIpAddresses+ +[]string + + |
+
+ OutboundIpAddresses: Outbound IP Addresses for container app. + |
+
+provisioningState+ + +ContainerApp_Properties_ProvisioningState_STATUS + + + |
+
+ ProvisioningState: Provisioning state of the Container App. + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+template+ + +Template_STATUS + + + |
+
+ Template: Container App versioned application definition. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” + |
+
+workloadProfileName+ +string + + |
+
+ WorkloadProfileName: Workload profile name to pin for container app execution. + |
+
+(Appears on:ContainerApp) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+configuration+ + +Configuration + + + |
+
+ Configuration: Non versioned Container App configuration properties. + |
+
+environmentReference+ + +genruntime.ResourceReference + + + |
+
+ EnvironmentReference: Resource ID of environment. + |
+
+extendedLocation+ + +ExtendedLocation + + + |
+
+ ExtendedLocation: The complex type of the extended location. + |
+
+identity+ + +ManagedServiceIdentity + + + |
+
+ Identity: managed identities for the Container App to interact with other Azure services without maintaining any secrets +or credentials in code. + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+managedByReference+ + +genruntime.ResourceReference + + + |
+
+ ManagedByReference: The fully qualified resource ID of the resource that manages this resource. Indicates if this +resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource +if it is removed from the template since it is managed by another resource. + |
+
+managedEnvironmentReference+ + +genruntime.ResourceReference + + + |
+
+ ManagedEnvironmentReference: Deprecated. Resource ID of the Container App’s environment. + |
+
+operatorSpec+ + +ContainerAppOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a resources.azure.com/ResourceGroup resource + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+template+ + +Template + + + |
+
+ Template: Container App versioned application definition. + |
+
+workloadProfileName+ +string + + |
+
+ WorkloadProfileName: Workload profile name to pin for container app execution. + |
+
+(Appears on:BaseContainer, Container) +
+Container App container resource requirements.
+| Field | +Description | +
|---|---|
+cpu+ +float64 + + |
+
+ Cpu: Required CPU in cores, e.g. 0.5 + |
+
+memory+ +string + + |
+
+ Memory: Required memory, e.g. “250Mb” + |
+
+(Appears on:BaseContainer_STATUS, Container_STATUS) +
+Container App container resource requirements.
+| Field | +Description | +
|---|---|
+cpu+ +float64 + + |
+
+ Cpu: Required CPU in cores, e.g. 0.5 + |
+
+ephemeralStorage+ +string + + |
+
+ EphemeralStorage: Ephemeral Storage, e.g. “1Gi” + |
+
+memory+ +string + + |
+
+ Memory: Required memory, e.g. “250Mb” + |
+
+(Appears on:JobTemplate_STATUS, Template_STATUS) +
+Container App container definition
+| Field | +Description | +
|---|---|
+args+ +[]string + + |
+
+ Args: Container start command arguments. + |
+
+command+ +[]string + + |
+
+ Command: Container start command. + |
+
+env+ + +[]EnvironmentVar_STATUS + + + |
+
+ Env: Container environment variables. + |
+
+image+ +string + + |
+
+ Image: Container image tag. + |
+
+name+ +string + + |
+
+ Name: Custom container name. + |
+
+probes+ + +[]ContainerAppProbe_STATUS + + + |
+
+ Probes: List of probes for the container. + |
+
+resources+ + +ContainerResources_STATUS + + + |
+
+ Resources: Container resource requirements. + |
+
+volumeMounts+ + +[]VolumeMount_STATUS + + + |
+
+ VolumeMounts: Container volume mounts. + |
+
+(Appears on:Login) +
+The configuration settings of the session cookie’s expiration.
+| Field | +Description | +
|---|---|
+convention+ + +CookieExpiration_Convention + + + |
+
+ Convention: The convention used when determining the session cookie’s expiration. + |
+
+timeToExpiration+ +string + + |
+
+ TimeToExpiration: The time after the request is made when the session cookie should expire. + |
+
string alias)+(Appears on:CookieExpiration) +
+| Value | +Description | +
|---|---|
"FixedTime" |
++ |
"IdentityProviderDerived" |
++ |
string alias)+(Appears on:CookieExpiration_STATUS) +
+| Value | +Description | +
|---|---|
"FixedTime" |
++ |
"IdentityProviderDerived" |
++ |
+(Appears on:Login_STATUS) +
+The configuration settings of the session cookie’s expiration.
+| Field | +Description | +
|---|---|
+convention+ + +CookieExpiration_Convention_STATUS + + + |
+
+ Convention: The convention used when determining the session cookie’s expiration. + |
+
+timeToExpiration+ +string + + |
+
+ TimeToExpiration: The time after the request is made when the session cookie should expire. + |
+
+(Appears on:Ingress) +
+Cross-Origin-Resource-Sharing policy
+| Field | +Description | +
|---|---|
+allowCredentials+ +bool + + |
+
+ AllowCredentials: Specifies whether the resource allows credentials + |
+
+allowedHeaders+ +[]string + + |
+
+ AllowedHeaders: Specifies the content for the access-control-allow-headers header + |
+
+allowedMethods+ +[]string + + |
+
+ AllowedMethods: Specifies the content for the access-control-allow-methods header + |
+
+allowedOrigins+ +[]string + + |
+
+ AllowedOrigins: Specifies the content for the access-control-allow-origins header + |
+
+exposeHeaders+ +[]string + + |
+
+ ExposeHeaders: Specifies the content for the access-control-expose-headers header + |
+
+maxAge+ +int + + |
+
+ MaxAge: Specifies the content for the access-control-max-age header + |
+
+(Appears on:Ingress_STATUS) +
+Cross-Origin-Resource-Sharing policy
+| Field | +Description | +
|---|---|
+allowCredentials+ +bool + + |
+
+ AllowCredentials: Specifies whether the resource allows credentials + |
+
+allowedHeaders+ +[]string + + |
+
+ AllowedHeaders: Specifies the content for the access-control-allow-headers header + |
+
+allowedMethods+ +[]string + + |
+
+ AllowedMethods: Specifies the content for the access-control-allow-methods header + |
+
+allowedOrigins+ +[]string + + |
+
+ AllowedOrigins: Specifies the content for the access-control-allow-origins header + |
+
+exposeHeaders+ +[]string + + |
+
+ ExposeHeaders: Specifies the content for the access-control-expose-headers header + |
+
+maxAge+ +int + + |
+
+ MaxAge: Specifies the content for the access-control-max-age header + |
+
+(Appears on:Ingress) +
+Custom Domain of a Container App
+| Field | +Description | +
|---|---|
+bindingType+ + +CustomDomain_BindingType + + + |
+
+ BindingType: Custom Domain binding type. + |
+
+certificateReference+ + +genruntime.ResourceReference + + + |
+
+ CertificateReference: Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. + |
+
+name+ +string + + |
+
+ Name: Hostname. + |
+
+(Appears on:ManagedEnvironment_Spec) +
+Configuration properties for apps environment custom domain
+| Field | +Description | +
|---|---|
+certificatePassword+ + +genruntime.SecretReference + + + |
+
+ CertificatePassword: Certificate password + |
+
+certificateValue+ + +genruntime.SecretReference + + + |
+
+ CertificateValue: PFX or PEM blob + |
+
+dnsSuffix+ +string + + |
+
+ DnsSuffix: Dns suffix for the environment domain + |
+
+(Appears on:ManagedEnvironment_STATUS) +
+Configuration properties for apps environment custom domain
+| Field | +Description | +
|---|---|
+customDomainVerificationId+ +string + + |
+
+ CustomDomainVerificationId: Id used to verify domain name ownership + |
+
+dnsSuffix+ +string + + |
+
+ DnsSuffix: Dns suffix for the environment domain + |
+
+expirationDate+ +string + + |
+
+ ExpirationDate: Certificate expiration date. + |
+
+subjectName+ +string + + |
+
+ SubjectName: Subject name of the certificate. + |
+
+thumbprint+ +string + + |
+
+ Thumbprint: Certificate thumbprint. + |
+
string alias)+(Appears on:CustomDomain) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"SniEnabled" |
++ |
string alias)+(Appears on:CustomDomain_STATUS) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"SniEnabled" |
++ |
+(Appears on:Ingress_STATUS) +
+Custom Domain of a Container App
+| Field | +Description | +
|---|---|
+bindingType+ + +CustomDomain_BindingType_STATUS + + + |
+
+ BindingType: Custom Domain binding type. + |
+
+certificateId+ +string + + |
+
+ CertificateId: Resource Id of the Certificate to be bound to this hostname. Must exist in the Managed Environment. + |
+
+name+ +string + + |
+
+ Name: Hostname. + |
+
+(Appears on:IdentityProviders) +
+The configuration settings of the custom Open ID Connect provider.
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: |
+
+login+ + +OpenIdConnectLogin + + + |
+
+ Login: The configuration settings of the login flow of the custom Open ID Connect provider. + |
+
+registration+ + +OpenIdConnectRegistration + + + |
+
+ Registration: The configuration settings of the app registration for the custom Open ID Connect provider. + |
+
+(Appears on:IdentityProviders_STATUS) +
+The configuration settings of the custom Open ID Connect provider.
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: |
+
+login+ + +OpenIdConnectLogin_STATUS + + + |
+
+ Login: The configuration settings of the login flow of the custom Open ID Connect provider. + |
+
+registration+ + +OpenIdConnectRegistration_STATUS + + + |
+
+ Registration: The configuration settings of the app registration for the custom Open ID Connect provider. + |
+
+(Appears on:ScaleRule) +
+Container App container Custom scaling rule.
+| Field | +Description | +
|---|---|
+auth+ + +[]ScaleRuleAuth + + + |
+
+ Auth: Authentication secrets for the custom scale rule. + |
+
+metadata+ +map[string]string + + |
+
+ Metadata: Metadata properties to describe custom scale rule. + |
+
+type+ +string + + |
+
+ Type: Type of the custom scale rule +eg: azure-servicebus, redis etc. + |
+
+(Appears on:ScaleRule_STATUS) +
+Container App container Custom scaling rule.
+| Field | +Description | +
|---|---|
+auth+ + +[]ScaleRuleAuth_STATUS + + + |
+
+ Auth: Authentication secrets for the custom scale rule. + |
+
+metadata+ +map[string]string + + |
+
+ Metadata: Metadata properties to describe custom scale rule. + |
+
+type+ +string + + |
+
+ Type: Type of the custom scale rule +eg: azure-servicebus, redis etc. + |
+
+(Appears on:Configuration) +
+Container App Dapr configuration.
+| Field | +Description | +
|---|---|
+appId+ +string + + |
+
+ AppId: Dapr application identifier + |
+
+appPort+ +int + + |
+
+ AppPort: Tells Dapr which port your application is listening on + |
+
+appProtocol+ + +Dapr_AppProtocol + + + |
+
+ AppProtocol: Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http + |
+
+enableApiLogging+ +bool + + |
+
+ EnableApiLogging: Enables API logging for the Dapr sidecar + |
+
+enabled+ +bool + + |
+
+ Enabled: Boolean indicating if the Dapr side car is enabled + |
+
+httpMaxRequestSize+ +int + + |
+
+ HttpMaxRequestSize: Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big +files. Default is 4 MB. + |
+
+httpReadBufferSize+ +int + + |
+
+ HttpReadBufferSize: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is +65KB. + |
+
+logLevel+ + +Dapr_LogLevel + + + |
+
+ LogLevel: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. + |
+
+(Appears on:ManagedEnvironment_STATUS) +
+Configuration properties Dapr component
+| Field | +Description | +
|---|---|
+version+ +string + + |
+
+ Version: The version of Dapr + |
+
string alias)+(Appears on:Dapr) +
+| Value | +Description | +
|---|---|
"grpc" |
++ |
"http" |
++ |
string alias)+(Appears on:Dapr_STATUS) +
+| Value | +Description | +
|---|---|
"grpc" |
++ |
"http" |
++ |
string alias)+(Appears on:Dapr) +
+| Value | +Description | +
|---|---|
"debug" |
++ |
"error" |
++ |
"info" |
++ |
"warn" |
++ |
string alias)+(Appears on:Dapr_STATUS) +
+| Value | +Description | +
|---|---|
"debug" |
++ |
"error" |
++ |
"info" |
++ |
"warn" |
++ |
+(Appears on:Configuration_STATUS) +
+Container App Dapr configuration.
+| Field | +Description | +
|---|---|
+appId+ +string + + |
+
+ AppId: Dapr application identifier + |
+
+appPort+ +int + + |
+
+ AppPort: Tells Dapr which port your application is listening on + |
+
+appProtocol+ + +Dapr_AppProtocol_STATUS + + + |
+
+ AppProtocol: Tells Dapr which protocol your application is using. Valid options are http and grpc. Default is http + |
+
+enableApiLogging+ +bool + + |
+
+ EnableApiLogging: Enables API logging for the Dapr sidecar + |
+
+enabled+ +bool + + |
+
+ Enabled: Boolean indicating if the Dapr side car is enabled + |
+
+httpMaxRequestSize+ +int + + |
+
+ HttpMaxRequestSize: Increasing max size of request body http and grpc servers parameter in MB to handle uploading of big +files. Default is 4 MB. + |
+
+httpReadBufferSize+ +int + + |
+
+ HttpReadBufferSize: Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is +65KB. + |
+
+logLevel+ + +Dapr_LogLevel_STATUS + + + |
+
+ LogLevel: Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info. + |
+
+(Appears on:AzureActiveDirectoryValidation) +
+The configuration settings of the Azure Active Directory default authorization policy.
+| Field | +Description | +
|---|---|
+allowedApplications+ +[]string + + |
+
+ AllowedApplications: The configuration settings of the Azure Active Directory allowed applications. + |
+
+allowedPrincipals+ + +AllowedPrincipals + + + |
+
+ AllowedPrincipals: The configuration settings of the Azure Active Directory allowed principals. + |
+
+(Appears on:AzureActiveDirectoryValidation_STATUS) +
+The configuration settings of the Azure Active Directory default authorization policy.
+| Field | +Description | +
|---|---|
+allowedApplications+ +[]string + + |
+
+ AllowedApplications: The configuration settings of the Azure Active Directory allowed applications. + |
+
+allowedPrincipals+ + +AllowedPrincipals_STATUS + + + |
+
+ AllowedPrincipals: The configuration settings of the Azure Active Directory allowed principals. + |
+
+(Appears on:AuthConfig_Spec) +
+The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service +Authentication/Authorization.
+| Field | +Description | +
|---|---|
+containerAppAuthEncryptionSecretName+ +string + + |
+
+ ContainerAppAuthEncryptionSecretName: The secret name which is referenced for EncryptionKey. + |
+
+containerAppAuthSigningSecretName+ +string + + |
+
+ ContainerAppAuthSigningSecretName: The secret name which is referenced for SigningKey. + |
+
+(Appears on:AuthConfig_STATUS) +
+The configuration settings of the secrets references of encryption key and signing key for ContainerApp Service +Authentication/Authorization.
+| Field | +Description | +
|---|---|
+containerAppAuthEncryptionSecretName+ +string + + |
+
+ ContainerAppAuthEncryptionSecretName: The secret name which is referenced for EncryptionKey. + |
+
+containerAppAuthSigningSecretName+ +string + + |
+
+ ContainerAppAuthSigningSecretName: The secret name which is referenced for SigningKey. + |
+
+(Appears on:BaseContainer, Container) +
+Container App container environment variable.
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: Environment variable name. + |
+
+secretRef+ +string + + |
+
+ SecretRef: Name of the Container App secret from which to pull the environment variable value. + |
+
+value+ +string + + |
+
+ Value: Non-secret environment variable value. + |
+
+(Appears on:BaseContainer_STATUS, Container_STATUS) +
+Container App container environment variable.
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: Environment variable name. + |
+
+secretRef+ +string + + |
+
+ SecretRef: Name of the Container App secret from which to pull the environment variable value. + |
+
+value+ +string + + |
+
+ Value: Non-secret environment variable value. + |
+
+(Appears on:ContainerApp_Spec) +
+The complex type of the extended location.
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: The name of the extended location. + |
+
+type+ + +ExtendedLocationType + + + |
+
+ Type: The type of the extended location. + |
+
string alias)+(Appears on:ExtendedLocation) +
+The type of extendedLocation.
+| Value | +Description | +
|---|---|
"CustomLocation" |
++ |
string alias)+(Appears on:ExtendedLocation_STATUS) +
+The type of extendedLocation.
+| Value | +Description | +
|---|---|
"CustomLocation" |
++ |
+(Appears on:ContainerApp_STATUS) +
+The complex type of the extended location.
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: The name of the extended location. + |
+
+type+ + +ExtendedLocationType_STATUS + + + |
+
+ Type: The type of the extended location. + |
+
+(Appears on:IdentityProviders) +
+The configuration settings of the Facebook provider.
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: |
+
+graphApiVersion+ +string + + |
+
+ GraphApiVersion: The version of the Facebook api to be used while logging in. + |
+
+login+ + +LoginScopes + + + |
+
+ Login: The configuration settings of the login flow. + |
+
+registration+ + +AppRegistration + + + |
+
+ Registration: The configuration settings of the app registration for the Facebook provider. + |
+
+(Appears on:IdentityProviders_STATUS) +
+The configuration settings of the Facebook provider.
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: |
+
+graphApiVersion+ +string + + |
+
+ GraphApiVersion: The version of the Facebook api to be used while logging in. + |
+
+login+ + +LoginScopes_STATUS + + + |
+
+ Login: The configuration settings of the login flow. + |
+
+registration+ + +AppRegistration_STATUS + + + |
+
+ Registration: The configuration settings of the app registration for the Facebook provider. + |
+
+(Appears on:HttpSettings) +
+The configuration settings of a forward proxy used to make the requests.
+| Field | +Description | +
|---|---|
+convention+ + +ForwardProxy_Convention + + + |
+
+ Convention: The convention used to determine the url of the request made. + |
+
+customHostHeaderName+ +string + + |
+
+ CustomHostHeaderName: The name of the header containing the host of the request. + |
+
+customProtoHeaderName+ +string + + |
+
+ CustomProtoHeaderName: The name of the header containing the scheme of the request. + |
+
string alias)+(Appears on:ForwardProxy) +
+| Value | +Description | +
|---|---|
"Custom" |
++ |
"NoProxy" |
++ |
"Standard" |
++ |
string alias)+(Appears on:ForwardProxy_STATUS) +
+| Value | +Description | +
|---|---|
"Custom" |
++ |
"NoProxy" |
++ |
"Standard" |
++ |
+(Appears on:HttpSettings_STATUS) +
+The configuration settings of a forward proxy used to make the requests.
+| Field | +Description | +
|---|---|
+convention+ + +ForwardProxy_Convention_STATUS + + + |
+
+ Convention: The convention used to determine the url of the request made. + |
+
+customHostHeaderName+ +string + + |
+
+ CustomHostHeaderName: The name of the header containing the host of the request. + |
+
+customProtoHeaderName+ +string + + |
+
+ CustomProtoHeaderName: The name of the header containing the scheme of the request. + |
+
+(Appears on:IdentityProviders) +
+The configuration settings of the GitHub provider.
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: |
+
+login+ + +LoginScopes + + + |
+
+ Login: The configuration settings of the login flow. + |
+
+registration+ + +ClientRegistration + + + |
+
+ Registration: The configuration settings of the app registration for the GitHub provider. + |
+
+(Appears on:IdentityProviders_STATUS) +
+The configuration settings of the GitHub provider.
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: |
+
+login+ + +LoginScopes_STATUS + + + |
+
+ Login: The configuration settings of the login flow. + |
+
+registration+ + +ClientRegistration_STATUS + + + |
+
+ Registration: The configuration settings of the app registration for the GitHub provider. + |
+
+(Appears on:AuthConfig_Spec) +
+The configuration settings that determines the validation flow of users using ContainerApp Service +Authentication/Authorization.
+| Field | +Description | +
|---|---|
+excludedPaths+ +[]string + + |
+
+ ExcludedPaths: The paths for which unauthenticated flow would not be redirected to the login page. + |
+
+redirectToProvider+ +string + + |
+
+ RedirectToProvider: The default authentication provider to use when multiple providers are configured. +This setting is only needed if multiple providers are configured and the unauthenticated client +action is set to “RedirectToLoginPage”. + |
+
+unauthenticatedClientAction+ + +GlobalValidation_UnauthenticatedClientAction + + + |
+
+ UnauthenticatedClientAction: The action to take when an unauthenticated client attempts to access the app. + |
+
+(Appears on:AuthConfig_STATUS) +
+The configuration settings that determines the validation flow of users using ContainerApp Service +Authentication/Authorization.
+| Field | +Description | +
|---|---|
+excludedPaths+ +[]string + + |
+
+ ExcludedPaths: The paths for which unauthenticated flow would not be redirected to the login page. + |
+
+redirectToProvider+ +string + + |
+
+ RedirectToProvider: The default authentication provider to use when multiple providers are configured. +This setting is only needed if multiple providers are configured and the unauthenticated client +action is set to “RedirectToLoginPage”. + |
+
+unauthenticatedClientAction+ + +GlobalValidation_UnauthenticatedClientAction_STATUS + + + |
+
+ UnauthenticatedClientAction: The action to take when an unauthenticated client attempts to access the app. + |
+
string alias)+(Appears on:GlobalValidation) +
+| Value | +Description | +
|---|---|
"AllowAnonymous" |
++ |
"RedirectToLoginPage" |
++ |
"Return401" |
++ |
"Return403" |
++ |
string alias)+(Appears on:GlobalValidation_STATUS) +
+| Value | +Description | +
|---|---|
"AllowAnonymous" |
++ |
"RedirectToLoginPage" |
++ |
"Return401" |
++ |
"Return403" |
++ |
+(Appears on:IdentityProviders) +
+The configuration settings of the Google provider.
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: |
+
+login+ + +LoginScopes + + + |
+
+ Login: The configuration settings of the login flow. + |
+
+registration+ + +ClientRegistration + + + |
+
+ Registration: The configuration settings of the app registration for the Google provider. + |
+
+validation+ + +AllowedAudiencesValidation + + + |
+
+ Validation: The configuration settings of the Azure Active Directory token validation flow. + |
+
+(Appears on:IdentityProviders_STATUS) +
+The configuration settings of the Google provider.
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: |
+
+login+ + +LoginScopes_STATUS + + + |
+
+ Login: The configuration settings of the login flow. + |
+
+registration+ + +ClientRegistration_STATUS + + + |
+
+ Registration: The configuration settings of the app registration for the Google provider. + |
+
+validation+ + +AllowedAudiencesValidation_STATUS + + + |
+
+ Validation: The configuration settings of the Azure Active Directory token validation flow. + |
+
+(Appears on:ScaleRule) +
+Container App container Http scaling rule.
+| Field | +Description | +
|---|---|
+auth+ + +[]ScaleRuleAuth + + + |
+
+ Auth: Authentication secrets for the custom scale rule. + |
+
+metadata+ +map[string]string + + |
+
+ Metadata: Metadata properties to describe http scale rule. + |
+
+(Appears on:ScaleRule_STATUS) +
+Container App container Http scaling rule.
+| Field | +Description | +
|---|---|
+auth+ + +[]ScaleRuleAuth_STATUS + + + |
+
+ Auth: Authentication secrets for the custom scale rule. + |
+
+metadata+ +map[string]string + + |
+
+ Metadata: Metadata properties to describe http scale rule. + |
+
+(Appears on:AuthConfig_Spec) +
+The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp +Service Authentication/Authorization.
+| Field | +Description | +
|---|---|
+forwardProxy+ + +ForwardProxy + + + |
+
+ ForwardProxy: The configuration settings of a forward proxy used to make the requests. + |
+
+requireHttps+ +bool + + |
+
+ RequireHttps: |
+
+routes+ + +HttpSettingsRoutes + + + |
+
+ Routes: The configuration settings of the paths HTTP requests. + |
+
+(Appears on:HttpSettings) +
+The configuration settings of the paths HTTP requests.
+| Field | +Description | +
|---|---|
+apiPrefix+ +string + + |
+
+ ApiPrefix: The prefix that should precede all the authentication/authorization paths. + |
+
+(Appears on:HttpSettings_STATUS) +
+The configuration settings of the paths HTTP requests.
+| Field | +Description | +
|---|---|
+apiPrefix+ +string + + |
+
+ ApiPrefix: The prefix that should precede all the authentication/authorization paths. + |
+
+(Appears on:AuthConfig_STATUS) +
+The configuration settings of the HTTP requests for authentication and authorization requests made against ContainerApp +Service Authentication/Authorization.
+| Field | +Description | +
|---|---|
+forwardProxy+ + +ForwardProxy_STATUS + + + |
+
+ ForwardProxy: The configuration settings of a forward proxy used to make the requests. + |
+
+requireHttps+ +bool + + |
+
+ RequireHttps: |
+
+routes+ + +HttpSettingsRoutes_STATUS + + + |
+
+ Routes: The configuration settings of the paths HTTP requests. + |
+
+(Appears on:AuthConfig_Spec) +
+The configuration settings of each of the identity providers used to configure ContainerApp Service +Authentication/Authorization.
+| Field | +Description | +
|---|---|
+apple+ + +Apple + + + |
+
+ Apple: The configuration settings of the Apple provider. + |
+
+azureActiveDirectory+ + +AzureActiveDirectory + + + |
+
+ AzureActiveDirectory: The configuration settings of the Azure Active directory provider. + |
+
+azureStaticWebApps+ + +AzureStaticWebApps + + + |
+
+ AzureStaticWebApps: The configuration settings of the Azure Static Web Apps provider. + |
+
+customOpenIdConnectProviders+ + +map[string]./api/app/v1api20240301.CustomOpenIdConnectProvider + + + |
+
+ CustomOpenIdConnectProviders: The map of the name of the alias of each custom Open ID Connect provider to the +configuration settings of the custom Open ID Connect provider. + |
+
+facebook+ + +Facebook + + + |
+
+ Facebook: The configuration settings of the Facebook provider. + |
+
+gitHub+ + +GitHub + + + |
+
+ GitHub: The configuration settings of the GitHub provider. + |
+
+google+ + +Google + + + |
+
+ Google: The configuration settings of the Google provider. + |
+
+twitter+ + +Twitter + + + |
+
+ Twitter: The configuration settings of the Twitter provider. + |
+
+(Appears on:AuthConfig_STATUS) +
+The configuration settings of each of the identity providers used to configure ContainerApp Service +Authentication/Authorization.
+| Field | +Description | +
|---|---|
+apple+ + +Apple_STATUS + + + |
+
+ Apple: The configuration settings of the Apple provider. + |
+
+azureActiveDirectory+ + +AzureActiveDirectory_STATUS + + + |
+
+ AzureActiveDirectory: The configuration settings of the Azure Active directory provider. + |
+
+azureStaticWebApps+ + +AzureStaticWebApps_STATUS + + + |
+
+ AzureStaticWebApps: The configuration settings of the Azure Static Web Apps provider. + |
+
+customOpenIdConnectProviders+ + +map[string]./api/app/v1api20240301.CustomOpenIdConnectProvider_STATUS + + + |
+
+ CustomOpenIdConnectProviders: The map of the name of the alias of each custom Open ID Connect provider to the +configuration settings of the custom Open ID Connect provider. + |
+
+facebook+ + +Facebook_STATUS + + + |
+
+ Facebook: The configuration settings of the Facebook provider. + |
+
+gitHub+ + +GitHub_STATUS + + + |
+
+ GitHub: The configuration settings of the GitHub provider. + |
+
+google+ + +Google_STATUS + + + |
+
+ Google: The configuration settings of the Google provider. + |
+
+twitter+ + +Twitter_STATUS + + + |
+
+ Twitter: The configuration settings of the Twitter provider. + |
+
+(Appears on:Configuration) +
+Container App Ingress configuration.
+| Field | +Description | +
|---|---|
+additionalPortMappings+ + +[]IngressPortMapping + + + |
+
+ AdditionalPortMappings: Settings to expose additional ports on container app + |
+
+allowInsecure+ +bool + + |
+
+ AllowInsecure: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically +redirected to HTTPS connections + |
+
+clientCertificateMode+ + +Ingress_ClientCertificateMode + + + |
+
+ ClientCertificateMode: Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate +on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require +indicates server requires a client certificate. + |
+
+corsPolicy+ + +CorsPolicy + + + |
+
+ CorsPolicy: CORS policy for container app + |
+
+customDomains+ + +[]CustomDomain + + + |
+
+ CustomDomains: custom domain bindings for Container Apps’ hostnames. + |
+
+exposedPort+ +int + + |
+
+ ExposedPort: Exposed Port in containers for TCP traffic from ingress + |
+
+external+ +bool + + |
+
+ External: Bool indicating if app exposes an external http endpoint + |
+
+ipSecurityRestrictions+ + +[]IpSecurityRestrictionRule + + + |
+
+ IpSecurityRestrictions: Rules to restrict incoming IP address. + |
+
+stickySessions+ + +Ingress_StickySessions + + + |
+
+ StickySessions: Sticky Sessions for Single Revision Mode + |
+
+targetPort+ +int + + |
+
+ TargetPort: Target Port in containers for traffic from ingress + |
+
+traffic+ + +[]TrafficWeight + + + |
+
+ Traffic: Traffic weights for app’s revisions + |
+
+transport+ + +Ingress_Transport + + + |
+
+ Transport: Ingress transport protocol + |
+
+(Appears on:Ingress) +
+Port mappings of container app ingress
+| Field | +Description | +
|---|---|
+exposedPort+ +int + + |
+
+ ExposedPort: Specifies the exposed port for the target port. If not specified, it defaults to target port + |
+
+external+ +bool + + |
+
+ External: Specifies whether the app port is accessible outside of the environment + |
+
+targetPort+ +int + + |
+
+ TargetPort: Specifies the port user’s container listens on + |
+
+(Appears on:Ingress_STATUS) +
+Port mappings of container app ingress
+| Field | +Description | +
|---|---|
+exposedPort+ +int + + |
+
+ ExposedPort: Specifies the exposed port for the target port. If not specified, it defaults to target port + |
+
+external+ +bool + + |
+
+ External: Specifies whether the app port is accessible outside of the environment + |
+
+targetPort+ +int + + |
+
+ TargetPort: Specifies the port user’s container listens on + |
+
string alias)+(Appears on:Ingress) +
+| Value | +Description | +
|---|---|
"accept" |
++ |
"ignore" |
++ |
"require" |
++ |
string alias)+(Appears on:Ingress_STATUS) +
+| Value | +Description | +
|---|---|
"accept" |
++ |
"ignore" |
++ |
"require" |
++ |
+(Appears on:Configuration_STATUS) +
+Container App Ingress configuration.
+| Field | +Description | +
|---|---|
+additionalPortMappings+ + +[]IngressPortMapping_STATUS + + + |
+
+ AdditionalPortMappings: Settings to expose additional ports on container app + |
+
+allowInsecure+ +bool + + |
+
+ AllowInsecure: Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically +redirected to HTTPS connections + |
+
+clientCertificateMode+ + +Ingress_ClientCertificateMode_STATUS + + + |
+
+ ClientCertificateMode: Client certificate mode for mTLS authentication. Ignore indicates server drops client certificate +on forwarding. Accept indicates server forwards client certificate but does not require a client certificate. Require +indicates server requires a client certificate. + |
+
+corsPolicy+ + +CorsPolicy_STATUS + + + |
+
+ CorsPolicy: CORS policy for container app + |
+
+customDomains+ + +[]CustomDomain_STATUS + + + |
+
+ CustomDomains: custom domain bindings for Container Apps’ hostnames. + |
+
+exposedPort+ +int + + |
+
+ ExposedPort: Exposed Port in containers for TCP traffic from ingress + |
+
+external+ +bool + + |
+
+ External: Bool indicating if app exposes an external http endpoint + |
+
+fqdn+ +string + + |
+
+ Fqdn: Hostname. + |
+
+ipSecurityRestrictions+ + +[]IpSecurityRestrictionRule_STATUS + + + |
+
+ IpSecurityRestrictions: Rules to restrict incoming IP address. + |
+
+stickySessions+ + +Ingress_StickySessions_STATUS + + + |
+
+ StickySessions: Sticky Sessions for Single Revision Mode + |
+
+targetPort+ +int + + |
+
+ TargetPort: Target Port in containers for traffic from ingress + |
+
+traffic+ + +[]TrafficWeight_STATUS + + + |
+
+ Traffic: Traffic weights for app’s revisions + |
+
+transport+ + +Ingress_Transport_STATUS + + + |
+
+ Transport: Ingress transport protocol + |
+
+(Appears on:Ingress) +
+| Field | +Description | +
|---|---|
+affinity+ + +Ingress_StickySessions_Affinity + + + |
+
+ Affinity: Sticky Session Affinity + |
+
string alias)+(Appears on:Ingress_StickySessions) +
+| Value | +Description | +
|---|---|
"none" |
++ |
"sticky" |
++ |
string alias)+(Appears on:Ingress_StickySessions_STATUS) +
+| Value | +Description | +
|---|---|
"none" |
++ |
"sticky" |
++ |
+(Appears on:Ingress_STATUS) +
+| Field | +Description | +
|---|---|
+affinity+ + +Ingress_StickySessions_Affinity_STATUS + + + |
+
+ Affinity: Sticky Session Affinity + |
+
string alias)+(Appears on:Ingress) +
+| Value | +Description | +
|---|---|
"auto" |
++ |
"http" |
++ |
"http2" |
++ |
"tcp" |
++ |
string alias)+(Appears on:Ingress_STATUS) +
+| Value | +Description | +
|---|---|
"auto" |
++ |
"http" |
++ |
"http2" |
++ |
"tcp" |
++ |
+(Appears on:Ingress) +
+Rule to restrict incoming IP address.
+| Field | +Description | +
|---|---|
+action+ + +IpSecurityRestrictionRule_Action + + + |
+
+ Action: Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny + |
+
+description+ +string + + |
+
+ Description: Describe the IP restriction rule that is being sent to the container-app. This is an optional field. + |
+
+ipAddressRange+ +string + + |
+
+ IpAddressRange: CIDR notation to match incoming IP address + |
+
+name+ +string + + |
+
+ Name: Name for the IP restriction rule. + |
+
string alias)+(Appears on:IpSecurityRestrictionRule) +
+| Value | +Description | +
|---|---|
"Allow" |
++ |
"Deny" |
++ |
string alias)+(Appears on:IpSecurityRestrictionRule_STATUS) +
+| Value | +Description | +
|---|---|
"Allow" |
++ |
"Deny" |
++ |
+(Appears on:Ingress_STATUS) +
+Rule to restrict incoming IP address.
+| Field | +Description | +
|---|---|
+action+ + +IpSecurityRestrictionRule_Action_STATUS + + + |
+
+ Action: Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or ALL Deny + |
+
+description+ +string + + |
+
+ Description: Describe the IP restriction rule that is being sent to the container-app. This is an optional field. + |
+
+ipAddressRange+ +string + + |
+
+ IpAddressRange: CIDR notation to match incoming IP address + |
+
+name+ +string + + |
+
+ Name: Name for the IP restriction rule. + |
+
Generator information: +- Generated from: /app/resource-manager/Microsoft.App/stable/2024-03-01/Jobs.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName} +
| Field | +Description | +||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||
+spec+ + +Job_Spec + + + |
+
+ + +
|
+||||||||||||||||||||
+status+ + +Job_STATUS + + + |
++ | +
+(Appears on:Job_Spec) +
+Non versioned Container Apps Job configuration properties
+| Field | +Description | +
|---|---|
+eventTriggerConfig+ + +JobConfiguration_EventTriggerConfig + + + |
+
+ EventTriggerConfig: Trigger configuration of an event driven job. + |
+
+manualTriggerConfig+ + +JobConfiguration_ManualTriggerConfig + + + |
+
+ ManualTriggerConfig: Manual trigger configuration for a single execution job. Properties replicaCompletionCount and +parallelism would be set to 1 by default + |
+
+registries+ + +[]RegistryCredentials + + + |
+
+ Registries: Collection of private container registry credentials used by a Container apps job + |
+
+replicaRetryLimit+ +int + + |
+
+ ReplicaRetryLimit: Maximum number of retries before failing the job. + |
+
+replicaTimeout+ +int + + |
+
+ ReplicaTimeout: Maximum number of seconds a replica is allowed to run. + |
+
+scheduleTriggerConfig+ + +JobConfiguration_ScheduleTriggerConfig + + + |
+
+ ScheduleTriggerConfig: Cron formatted repeating trigger schedule (“* * * * *”) for cronjobs. Properties completions and +parallelism would be set to 1 by default + |
+
+secrets+ + +[]Secret + + + |
+
+ Secrets: Collection of secrets used by a Container Apps Job + |
+
+triggerType+ + +JobConfiguration_TriggerType + + + |
+
+ TriggerType: Trigger type of the job + |
+
+(Appears on:JobConfiguration) +
+| Field | +Description | +
|---|---|
+parallelism+ +int + + |
++ | +
+replicaCompletionCount+ +int + + |
++ | +
+scale+ + +JobScale + + + |
+
+ Scale: Scaling configurations for event driven jobs. + |
+
+(Appears on:JobConfiguration_STATUS) +
+| Field | +Description | +
|---|---|
+parallelism+ +int + + |
++ | +
+replicaCompletionCount+ +int + + |
++ | +
+scale+ + +JobScale_STATUS + + + |
+
+ Scale: Scaling configurations for event driven jobs. + |
+
+(Appears on:JobConfiguration) +
+| Field | +Description | +
|---|---|
+parallelism+ +int + + |
++ | +
+replicaCompletionCount+ +int + + |
++ | +
+(Appears on:JobConfiguration_STATUS) +
+| Field | +Description | +
|---|---|
+parallelism+ +int + + |
++ | +
+replicaCompletionCount+ +int + + |
++ | +
+(Appears on:Job_STATUS) +
+Non versioned Container Apps Job configuration properties
+| Field | +Description | +
|---|---|
+eventTriggerConfig+ + +JobConfiguration_EventTriggerConfig_STATUS + + + |
+
+ EventTriggerConfig: Trigger configuration of an event driven job. + |
+
+manualTriggerConfig+ + +JobConfiguration_ManualTriggerConfig_STATUS + + + |
+
+ ManualTriggerConfig: Manual trigger configuration for a single execution job. Properties replicaCompletionCount and +parallelism would be set to 1 by default + |
+
+registries+ + +[]RegistryCredentials_STATUS + + + |
+
+ Registries: Collection of private container registry credentials used by a Container apps job + |
+
+replicaRetryLimit+ +int + + |
+
+ ReplicaRetryLimit: Maximum number of retries before failing the job. + |
+
+replicaTimeout+ +int + + |
+
+ ReplicaTimeout: Maximum number of seconds a replica is allowed to run. + |
+
+scheduleTriggerConfig+ + +JobConfiguration_ScheduleTriggerConfig_STATUS + + + |
+
+ ScheduleTriggerConfig: Cron formatted repeating trigger schedule (“* * * * *”) for cronjobs. Properties completions and +parallelism would be set to 1 by default + |
+
+secrets+ + +[]Secret_STATUS + + + |
+
+ Secrets: Collection of secrets used by a Container Apps Job + |
+
+triggerType+ + +JobConfiguration_TriggerType_STATUS + + + |
+
+ TriggerType: Trigger type of the job + |
+
+(Appears on:JobConfiguration) +
+| Field | +Description | +
|---|---|
+cronExpression+ +string + + |
+
+ CronExpression: Cron formatted repeating schedule (“* * * * *”) of a Cron Job. + |
+
+parallelism+ +int + + |
++ | +
+replicaCompletionCount+ +int + + |
++ | +
+(Appears on:JobConfiguration_STATUS) +
+| Field | +Description | +
|---|---|
+cronExpression+ +string + + |
+
+ CronExpression: Cron formatted repeating schedule (“* * * * *”) of a Cron Job. + |
+
+parallelism+ +int + + |
++ | +
+replicaCompletionCount+ +int + + |
++ | +
string alias)+(Appears on:JobConfiguration) +
+| Value | +Description | +
|---|---|
"Event" |
++ |
"Manual" |
++ |
"Schedule" |
++ |
string alias)+(Appears on:JobConfiguration_STATUS) +
+| Value | +Description | +
|---|---|
"Event" |
++ |
"Manual" |
++ |
"Schedule" |
++ |
+(Appears on:Job_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:JobConfiguration_EventTriggerConfig) +
+Scaling configurations for event driven jobs.
+| Field | +Description | +
|---|---|
+maxExecutions+ +int + + |
+
+ MaxExecutions: Maximum number of job executions that are created for a trigger, default 100. + |
+
+minExecutions+ +int + + |
+
+ MinExecutions: Minimum number of job executions that are created for a trigger, default 0 + |
+
+pollingInterval+ +int + + |
++ | +
+rules+ + +[]JobScaleRule + + + |
+
+ Rules: Scaling rules. + |
+
+(Appears on:JobScale) +
+Scaling rule.
+| Field | +Description | +
|---|---|
+auth+ + +[]ScaleRuleAuth + + + |
+
+ Auth: Authentication secrets for the scale rule. + |
+
+metadata+ + +map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + + + |
+
+ Metadata: Metadata properties to describe the scale rule. + |
+
+name+ +string + + |
+
+ Name: Scale Rule Name + |
+
+type+ +string + + |
+
+ Type: Type of the scale rule +eg: azure-servicebus, redis etc. + |
+
+(Appears on:JobScale_STATUS) +
+Scaling rule.
+| Field | +Description | +
|---|---|
+auth+ + +[]ScaleRuleAuth_STATUS + + + |
+
+ Auth: Authentication secrets for the scale rule. + |
+
+metadata+ + +map[string]k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1.JSON + + + |
+
+ Metadata: Metadata properties to describe the scale rule. + |
+
+name+ +string + + |
+
+ Name: Scale Rule Name + |
+
+type+ +string + + |
+
+ Type: Type of the scale rule +eg: azure-servicebus, redis etc. + |
+
+(Appears on:JobConfiguration_EventTriggerConfig_STATUS) +
+Scaling configurations for event driven jobs.
+| Field | +Description | +
|---|---|
+maxExecutions+ +int + + |
+
+ MaxExecutions: Maximum number of job executions that are created for a trigger, default 100. + |
+
+minExecutions+ +int + + |
+
+ MinExecutions: Minimum number of job executions that are created for a trigger, default 0 + |
+
+pollingInterval+ +int + + |
++ | +
+rules+ + +[]JobScaleRule_STATUS + + + |
+
+ Rules: Scaling rules. + |
+
+(Appears on:Job_Spec) +
+Container Apps Job versioned application definition. Defines the desired state of an immutable revision. Any changes to +this section Will result in a new revision being created
+| Field | +Description | +
|---|---|
+containers+ + +[]Container + + + |
+
+ Containers: List of container definitions for the Container App. + |
+
+initContainers+ + +[]BaseContainer + + + |
+
+ InitContainers: List of specialized containers that run before app containers. + |
+
+volumes+ + +[]Volume + + + |
+
+ Volumes: List of volume definitions for the Container App. + |
+
+(Appears on:Job_STATUS) +
+Container Apps Job versioned application definition. Defines the desired state of an immutable revision. Any changes to +this section Will result in a new revision being created
+| Field | +Description | +
|---|---|
+containers+ + +[]Container_STATUS + + + |
+
+ Containers: List of container definitions for the Container App. + |
+
+initContainers+ + +[]BaseContainer_STATUS + + + |
+
+ InitContainers: List of specialized containers that run before app containers. + |
+
+volumes+ + +[]Volume_STATUS + + + |
+
+ Volumes: List of volume definitions for the Container App. + |
+
string alias)+(Appears on:Job_STATUS) +
+| Value | +Description | +
|---|---|
"Canceled" |
++ |
"Deleting" |
++ |
"Failed" |
++ |
"InProgress" |
++ |
"Succeeded" |
++ |
+(Appears on:Job) +
+Container App Job
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+configuration+ + +JobConfiguration_STATUS + + + |
+
+ Configuration: Container Apps Job configuration properties. + |
+
+environmentId+ +string + + |
+
+ EnvironmentId: Resource ID of environment. + |
+
+eventStreamEndpoint+ +string + + |
+
+ EventStreamEndpoint: The endpoint of the eventstream of the container apps job. + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} + |
+
+identity+ + +ManagedServiceIdentity_STATUS + + + |
+
+ Identity: Managed identities needed by a container app job to interact with other Azure services to not maintain any +secrets or credentials in code. + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+outboundIpAddresses+ +[]string + + |
+
+ OutboundIpAddresses: Outbound IP Addresses of a container apps job. + |
+
+provisioningState+ + +Job_Properties_ProvisioningState_STATUS + + + |
+
+ ProvisioningState: Provisioning state of the Container Apps Job. + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+template+ + +JobTemplate_STATUS + + + |
+
+ Template: Container Apps job definition. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” + |
+
+workloadProfileName+ +string + + |
+
+ WorkloadProfileName: Workload profile name to pin for container apps job execution. + |
+
+(Appears on:Job) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+configuration+ + +JobConfiguration + + + |
+
+ Configuration: Container Apps Job configuration properties. + |
+
+environmentReference+ + +genruntime.ResourceReference + + + |
+
+ EnvironmentReference: Resource ID of environment. + |
+
+identity+ + +ManagedServiceIdentity + + + |
+
+ Identity: Managed identities needed by a container app job to interact with other Azure services to not maintain any +secrets or credentials in code. + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+operatorSpec+ + +JobOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a resources.azure.com/ResourceGroup resource + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+template+ + +JobTemplate + + + |
+
+ Template: Container Apps job definition. + |
+
+workloadProfileName+ +string + + |
+
+ WorkloadProfileName: Workload profile name to pin for container apps job execution. + |
+
+(Appears on:AzureActiveDirectoryValidation) +
+The configuration settings of the checks that should be made while validating the JWT Claims.
+| Field | +Description | +
|---|---|
+allowedClientApplications+ +[]string + + |
+
+ AllowedClientApplications: The list of the allowed client applications. + |
+
+allowedGroups+ +[]string + + |
+
+ AllowedGroups: The list of the allowed groups. + |
+
+(Appears on:AzureActiveDirectoryValidation_STATUS) +
+The configuration settings of the checks that should be made while validating the JWT Claims.
+| Field | +Description | +
|---|---|
+allowedClientApplications+ +[]string + + |
+
+ AllowedClientApplications: The list of the allowed client applications. + |
+
+allowedGroups+ +[]string + + |
+
+ AllowedGroups: The list of the allowed groups. + |
+
+(Appears on:ManagedEnvironment_STATUS) +
+Configuration properties Keda component
+| Field | +Description | +
|---|---|
+version+ +string + + |
+
+ Version: The version of Keda + |
+
+(Appears on:AppLogsConfiguration) +
+Log Analytics configuration, must only be provided when destination is configured as ‘log-analytics’
+| Field | +Description | +
|---|---|
+customerId+ +string + + |
+
+ CustomerId: Log analytics customer id + |
+
+sharedKey+ + +genruntime.SecretReference + + + |
+
+ SharedKey: Log analytics customer key + |
+
+(Appears on:AppLogsConfiguration_STATUS) +
+Log Analytics configuration, must only be provided when destination is configured as ‘log-analytics’
+| Field | +Description | +
|---|---|
+customerId+ +string + + |
+
+ CustomerId: Log analytics customer id + |
+
+(Appears on:AuthConfig_Spec) +
+The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.
+| Field | +Description | +
|---|---|
+allowedExternalRedirectUrls+ +[]string + + |
+
+ AllowedExternalRedirectUrls: External URLs that can be redirected to as part of logging in or logging out of the app. +Note that the query string part of the URL is ignored. +This is an advanced setting typically only needed by Windows Store application backends. +Note that URLs within the current domain are always implicitly allowed. + |
+
+cookieExpiration+ + +CookieExpiration + + + |
+
+ CookieExpiration: The configuration settings of the session cookie’s expiration. + |
+
+nonce+ + +Nonce + + + |
+
+ Nonce: The configuration settings of the nonce used in the login flow. + |
+
+preserveUrlFragmentsForLogins+ +bool + + |
+
+ PreserveUrlFragmentsForLogins: |
+
+routes+ + +LoginRoutes + + + |
+
+ Routes: The routes that specify the endpoints used for login and logout requests. + |
+
+tokenStore+ + +TokenStore + + + |
+
+ TokenStore: The configuration settings of the token store. + |
+
+(Appears on:Login) +
+The routes that specify the endpoints used for login and logout requests.
+| Field | +Description | +
|---|---|
+logoutEndpoint+ +string + + |
+
+ LogoutEndpoint: The endpoint at which a logout request should be made. + |
+
+(Appears on:Login_STATUS) +
+The routes that specify the endpoints used for login and logout requests.
+| Field | +Description | +
|---|---|
+logoutEndpoint+ +string + + |
+
+ LogoutEndpoint: The endpoint at which a logout request should be made. + |
+
+(Appears on:Apple, Facebook, GitHub, Google) +
+The configuration settings of the login flow, including the scopes that should be requested.
+| Field | +Description | +
|---|---|
+scopes+ +[]string + + |
+
+ Scopes: A list of the scopes that should be requested while authenticating. + |
+
+(Appears on:Apple_STATUS, Facebook_STATUS, GitHub_STATUS, Google_STATUS) +
+The configuration settings of the login flow, including the scopes that should be requested.
+| Field | +Description | +
|---|---|
+scopes+ +[]string + + |
+
+ Scopes: A list of the scopes that should be requested while authenticating. + |
+
+(Appears on:AuthConfig_STATUS) +
+The configuration settings of the login flow of users using ContainerApp Service Authentication/Authorization.
+| Field | +Description | +
|---|---|
+allowedExternalRedirectUrls+ +[]string + + |
+
+ AllowedExternalRedirectUrls: External URLs that can be redirected to as part of logging in or logging out of the app. +Note that the query string part of the URL is ignored. +This is an advanced setting typically only needed by Windows Store application backends. +Note that URLs within the current domain are always implicitly allowed. + |
+
+cookieExpiration+ + +CookieExpiration_STATUS + + + |
+
+ CookieExpiration: The configuration settings of the session cookie’s expiration. + |
+
+nonce+ + +Nonce_STATUS + + + |
+
+ Nonce: The configuration settings of the nonce used in the login flow. + |
+
+preserveUrlFragmentsForLogins+ +bool + + |
+
+ PreserveUrlFragmentsForLogins: |
+
+routes+ + +LoginRoutes_STATUS + + + |
+
+ Routes: The routes that specify the endpoints used for login and logout requests. + |
+
+tokenStore+ + +TokenStore_STATUS + + + |
+
+ TokenStore: The configuration settings of the token store. + |
+
Generator information: +- Generated from: /app/resource-manager/Microsoft.App/stable/2024-03-01/ManagedEnvironments.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/managedEnvironments/{environmentName} +
| Field | +Description | +||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||||||||||||||
+spec+ + +ManagedEnvironment_Spec + + + |
+
+ + +
|
+||||||||||||||||||||||||||||||||
+status+ + +ManagedEnvironment_STATUS + + + |
++ | +
+(Appears on:ManagedEnvironment_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:ManagedEnvironment_STATUS) +
+| Field | +Description | +
|---|---|
+mtls+ + +Mtls_STATUS + + + |
+
+ Mtls: Mutual TLS authentication settings for the Managed Environment + |
+
+(Appears on:ManagedEnvironment_Spec) +
+| Field | +Description | +
|---|---|
+mtls+ + +Mtls + + + |
+
+ Mtls: Mutual TLS authentication settings for the Managed Environment + |
+
+(Appears on:ManagedEnvironment_Properties_PeerTrafficConfiguration_STATUS) +
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: Boolean indicating whether the peer traffic encryption is enabled + |
+
+(Appears on:ManagedEnvironment_Properties_PeerTrafficConfiguration_Spec) +
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: Boolean indicating whether the peer traffic encryption is enabled + |
+
+(Appears on:ManagedEnvironment_STATUS) +
+| Field | +Description | +
|---|---|
+encryption+ + +ManagedEnvironment_Properties_PeerTrafficConfiguration_Encryption_STATUS + + + |
+
+ Encryption: Peer traffic encryption settings for the Managed Environment + |
+
+(Appears on:ManagedEnvironment_Spec) +
+| Field | +Description | +
|---|---|
+encryption+ + +ManagedEnvironment_Properties_PeerTrafficConfiguration_Encryption_Spec + + + |
+
+ Encryption: Peer traffic encryption settings for the Managed Environment + |
+
string alias)+(Appears on:ManagedEnvironment_STATUS) +
+| Value | +Description | +
|---|---|
"Canceled" |
++ |
"Failed" |
++ |
"InfrastructureSetupComplete" |
++ |
"InfrastructureSetupInProgress" |
++ |
"InitializationInProgress" |
++ |
"ScheduledForDelete" |
++ |
"Succeeded" |
++ |
"UpgradeFailed" |
++ |
"UpgradeRequested" |
++ |
"Waiting" |
++ |
+(Appears on:ManagedEnvironment) +
+An environment for hosting container apps
+| Field | +Description | +
|---|---|
+appLogsConfiguration+ + +AppLogsConfiguration_STATUS + + + |
+
+ AppLogsConfiguration: Cluster configuration which enables the log daemon to export app logs to configured destination. + |
+
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+customDomainConfiguration+ + +CustomDomainConfiguration_STATUS + + + |
+
+ CustomDomainConfiguration: Custom domain configuration for the environment + |
+
+daprConfiguration+ + +DaprConfiguration_STATUS + + + |
+
+ DaprConfiguration: The configuration of Dapr component. + |
+
+defaultDomain+ +string + + |
+
+ DefaultDomain: Default Domain Name for the cluster + |
+
+deploymentErrors+ +string + + |
+
+ DeploymentErrors: Any errors that occurred during deployment or deployment validation + |
+
+eventStreamEndpoint+ +string + + |
+
+ EventStreamEndpoint: The endpoint of the eventstream of the Environment. + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} + |
+
+infrastructureResourceGroup+ +string + + |
+
+ InfrastructureResourceGroup: Name of the platform-managed resource group created for the Managed Environment to host +infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as +the subnet. + |
+
+kedaConfiguration+ + +KedaConfiguration_STATUS + + + |
+
+ KedaConfiguration: The configuration of Keda component. + |
+
+kind+ +string + + |
+
+ Kind: Kind of the Environment. + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+peerAuthentication+ + +ManagedEnvironment_Properties_PeerAuthentication_STATUS + + + |
+
+ PeerAuthentication: Peer authentication settings for the Managed Environment + |
+
+peerTrafficConfiguration+ + +ManagedEnvironment_Properties_PeerTrafficConfiguration_STATUS + + + |
+
+ PeerTrafficConfiguration: Peer traffic settings for the Managed Environment + |
+
+provisioningState+ + +ManagedEnvironment_Properties_ProvisioningState_STATUS + + + |
+
+ ProvisioningState: Provisioning state of the Environment. + |
+
+staticIp+ +string + + |
+
+ StaticIp: Static IP of the Environment + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” + |
+
+vnetConfiguration+ + +VnetConfiguration_STATUS + + + |
+
+ VnetConfiguration: Vnet configuration for the environment + |
+
+workloadProfiles+ + +[]WorkloadProfile_STATUS + + + |
+
+ WorkloadProfiles: Workload profiles configured for the Managed Environment. + |
+
+zoneRedundant+ +bool + + |
+
+ ZoneRedundant: Whether or not this Managed Environment is zone-redundant. + |
+
+(Appears on:ManagedEnvironment) +
+| Field | +Description | +
|---|---|
+appLogsConfiguration+ + +AppLogsConfiguration + + + |
+
+ AppLogsConfiguration: Cluster configuration which enables the log daemon to export app logs to configured destination. + |
+
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+customDomainConfiguration+ + +CustomDomainConfiguration + + + |
+
+ CustomDomainConfiguration: Custom domain configuration for the environment + |
+
+daprAIConnectionString+ + +genruntime.SecretReference + + + |
+
+ DaprAIConnectionString: Application Insights connection string used by Dapr to export Service to Service communication +telemetry + |
+
+daprAIInstrumentationKey+ + +genruntime.SecretReference + + + |
+
+ DaprAIInstrumentationKey: Azure Monitor instrumentation key used by Dapr to export Service to Service communication +telemetry + |
+
+infrastructureResourceGroup+ +string + + |
+
+ InfrastructureResourceGroup: Name of the platform-managed resource group created for the Managed Environment to host +infrastructure resources. If a subnet ID is provided, this resource group will be created in the same subscription as +the subnet. + |
+
+kind+ +string + + |
+
+ Kind: Kind of the Environment. + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+operatorSpec+ + +ManagedEnvironmentOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a resources.azure.com/ResourceGroup resource + |
+
+peerAuthentication+ + +ManagedEnvironment_Properties_PeerAuthentication_Spec + + + |
+
+ PeerAuthentication: Peer authentication settings for the Managed Environment + |
+
+peerTrafficConfiguration+ + +ManagedEnvironment_Properties_PeerTrafficConfiguration_Spec + + + |
+
+ PeerTrafficConfiguration: Peer traffic settings for the Managed Environment + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+vnetConfiguration+ + +VnetConfiguration + + + |
+
+ VnetConfiguration: Vnet configuration for the environment + |
+
+workloadProfiles+ + +[]WorkloadProfile + + + |
+
+ WorkloadProfiles: Workload profiles configured for the Managed Environment. + |
+
+zoneRedundant+ +bool + + |
+
+ ZoneRedundant: Whether or not this Managed Environment is zone-redundant. + |
+
+(Appears on:ContainerApp_Spec, Job_Spec) +
+Managed service identity (system assigned and/or user assigned identities)
+| Field | +Description | +
|---|---|
+type+ + +ManagedServiceIdentityType + + + |
+
+ Type: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + |
+
+userAssignedIdentities+ + +[]UserAssignedIdentityDetails + + + |
++ | +
string alias)+(Appears on:ManagedServiceIdentity) +
+Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
+| Value | +Description | +
|---|---|
"None" |
++ |
"SystemAssigned" |
++ |
"SystemAssigned,UserAssigned" |
++ |
"UserAssigned" |
++ |
string alias)+(Appears on:ManagedServiceIdentity_STATUS) +
+Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).
+| Value | +Description | +
|---|---|
"None" |
++ |
"SystemAssigned" |
++ |
"SystemAssigned,UserAssigned" |
++ |
"UserAssigned" |
++ |
+(Appears on:ContainerApp_STATUS, Job_STATUS) +
+Managed service identity (system assigned and/or user assigned identities)
+| Field | +Description | +
|---|---|
+principalId+ +string + + |
+
+ PrincipalId: The service principal ID of the system assigned identity. This property will only be provided for a system +assigned identity. + |
+
+tenantId+ +string + + |
+
+ TenantId: The tenant ID of the system assigned identity. This property will only be provided for a system assigned +identity. + |
+
+type+ + +ManagedServiceIdentityType_STATUS + + + |
+
+ Type: Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed). + |
+
+userAssignedIdentities+ + +map[string]./api/app/v1api20240301.UserAssignedIdentity_STATUS + + + |
++ | +
+(Appears on:ManagedEnvironment_Properties_PeerAuthentication_Spec) +
+Configuration properties for mutual TLS authentication
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: Boolean indicating whether the mutual TLS authentication is enabled + |
+
+(Appears on:ManagedEnvironment_Properties_PeerAuthentication_STATUS) +
+Configuration properties for mutual TLS authentication
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: Boolean indicating whether the mutual TLS authentication is enabled + |
+
+(Appears on:Login) +
+The configuration settings of the nonce used in the login flow.
+| Field | +Description | +
|---|---|
+nonceExpirationInterval+ +string + + |
+
+ NonceExpirationInterval: The time after the request is made when the nonce should expire. + |
+
+validateNonce+ +bool + + |
+
+ ValidateNonce: |
+
+(Appears on:Login_STATUS) +
+The configuration settings of the nonce used in the login flow.
+| Field | +Description | +
|---|---|
+nonceExpirationInterval+ +string + + |
+
+ NonceExpirationInterval: The time after the request is made when the nonce should expire. + |
+
+validateNonce+ +bool + + |
+
+ ValidateNonce: |
+
+(Appears on:OpenIdConnectRegistration) +
+The authentication client credentials of the custom Open ID Connect provider.
+| Field | +Description | +
|---|---|
+clientSecretSettingName+ +string + + |
+
+ ClientSecretSettingName: The app setting that contains the client secret for the custom Open ID Connect provider. + |
+
+method+ + +OpenIdConnectClientCredential_Method + + + |
+
+ Method: The method that should be used to authenticate the user. + |
+
string alias)+(Appears on:OpenIdConnectClientCredential) +
+| Value | +Description | +
|---|---|
"ClientSecretPost" |
++ |
string alias)+(Appears on:OpenIdConnectClientCredential_STATUS) +
+| Value | +Description | +
|---|---|
"ClientSecretPost" |
++ |
+(Appears on:OpenIdConnectRegistration_STATUS) +
+The authentication client credentials of the custom Open ID Connect provider.
+| Field | +Description | +
|---|---|
+clientSecretSettingName+ +string + + |
+
+ ClientSecretSettingName: The app setting that contains the client secret for the custom Open ID Connect provider. + |
+
+method+ + +OpenIdConnectClientCredential_Method_STATUS + + + |
+
+ Method: The method that should be used to authenticate the user. + |
+
+(Appears on:OpenIdConnectRegistration) +
+The configuration settings of the endpoints used for the custom Open ID Connect provider.
+| Field | +Description | +
|---|---|
+authorizationEndpoint+ +string + + |
+
+ AuthorizationEndpoint: The endpoint to be used to make an authorization request. + |
+
+certificationUri+ +string + + |
+
+ CertificationUri: The endpoint that provides the keys necessary to validate the token. + |
+
+issuer+ +string + + |
+
+ Issuer: The endpoint that issues the token. + |
+
+tokenEndpoint+ +string + + |
+
+ TokenEndpoint: The endpoint to be used to request a token. + |
+
+wellKnownOpenIdConfiguration+ +string + + |
+
+ WellKnownOpenIdConfiguration: The endpoint that contains all the configuration endpoints for the provider. + |
+
+(Appears on:OpenIdConnectRegistration_STATUS) +
+The configuration settings of the endpoints used for the custom Open ID Connect provider.
+| Field | +Description | +
|---|---|
+authorizationEndpoint+ +string + + |
+
+ AuthorizationEndpoint: The endpoint to be used to make an authorization request. + |
+
+certificationUri+ +string + + |
+
+ CertificationUri: The endpoint that provides the keys necessary to validate the token. + |
+
+issuer+ +string + + |
+
+ Issuer: The endpoint that issues the token. + |
+
+tokenEndpoint+ +string + + |
+
+ TokenEndpoint: The endpoint to be used to request a token. + |
+
+wellKnownOpenIdConfiguration+ +string + + |
+
+ WellKnownOpenIdConfiguration: The endpoint that contains all the configuration endpoints for the provider. + |
+
+(Appears on:CustomOpenIdConnectProvider) +
+The configuration settings of the login flow of the custom Open ID Connect provider.
+| Field | +Description | +
|---|---|
+nameClaimType+ +string + + |
+
+ NameClaimType: The name of the claim that contains the users name. + |
+
+scopes+ +[]string + + |
+
+ Scopes: A list of the scopes that should be requested while authenticating. + |
+
+(Appears on:CustomOpenIdConnectProvider_STATUS) +
+The configuration settings of the login flow of the custom Open ID Connect provider.
+| Field | +Description | +
|---|---|
+nameClaimType+ +string + + |
+
+ NameClaimType: The name of the claim that contains the users name. + |
+
+scopes+ +[]string + + |
+
+ Scopes: A list of the scopes that should be requested while authenticating. + |
+
+(Appears on:CustomOpenIdConnectProvider) +
+The configuration settings of the app registration for the custom Open ID Connect provider.
+| Field | +Description | +
|---|---|
+clientCredential+ + +OpenIdConnectClientCredential + + + |
+
+ ClientCredential: The authentication credentials of the custom Open ID Connect provider. + |
+
+clientId+ +string + + |
+
+ ClientId: The client id of the custom Open ID Connect provider. + |
+
+openIdConnectConfiguration+ + +OpenIdConnectConfig + + + |
+
+ OpenIdConnectConfiguration: The configuration settings of the endpoints used for the custom Open ID Connect provider. + |
+
+(Appears on:CustomOpenIdConnectProvider_STATUS) +
+The configuration settings of the app registration for the custom Open ID Connect provider.
+| Field | +Description | +
|---|---|
+clientCredential+ + +OpenIdConnectClientCredential_STATUS + + + |
+
+ ClientCredential: The authentication credentials of the custom Open ID Connect provider. + |
+
+clientId+ +string + + |
+
+ ClientId: The client id of the custom Open ID Connect provider. + |
+
+openIdConnectConfiguration+ + +OpenIdConnectConfig_STATUS + + + |
+
+ OpenIdConnectConfiguration: The configuration settings of the endpoints used for the custom Open ID Connect provider. + |
+
+(Appears on:ScaleRule) +
+Container App container Azure Queue based scaling rule.
+| Field | +Description | +
|---|---|
+auth+ + +[]ScaleRuleAuth + + + |
+
+ Auth: Authentication secrets for the queue scale rule. + |
+
+queueLength+ +int + + |
+
+ QueueLength: Queue length. + |
+
+queueName+ +string + + |
+
+ QueueName: Queue name. + |
+
+(Appears on:ScaleRule_STATUS) +
+Container App container Azure Queue based scaling rule.
+| Field | +Description | +
|---|---|
+auth+ + +[]ScaleRuleAuth_STATUS + + + |
+
+ Auth: Authentication secrets for the queue scale rule. + |
+
+queueLength+ +int + + |
+
+ QueueLength: Queue length. + |
+
+queueName+ +string + + |
+
+ QueueName: Queue name. + |
+
+(Appears on:Configuration, JobConfiguration) +
+Container App Private Registry
+| Field | +Description | +
|---|---|
+identityReference+ + +genruntime.ResourceReference + + + |
+
+ IdentityReference: A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned +identities, use the full user-assigned identity Resource ID. For system-assigned identities, use ‘system’ + |
+
+passwordSecretRef+ +string + + |
+
+ PasswordSecretRef: The name of the Secret that contains the registry login password + |
+
+server+ +string + + |
+
+ Server: Container Registry Server + |
+
+username+ +string + + |
+
+ Username: Container Registry Username + |
+
+(Appears on:Configuration_STATUS, JobConfiguration_STATUS) +
+Container App Private Registry
+| Field | +Description | +
|---|---|
+identity+ +string + + |
+
+ Identity: A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the +full user-assigned identity Resource ID. For system-assigned identities, use ‘system’ + |
+
+passwordSecretRef+ +string + + |
+
+ PasswordSecretRef: The name of the Secret that contains the registry login password + |
+
+server+ +string + + |
+
+ Server: Container Registry Server + |
+
+username+ +string + + |
+
+ Username: Container Registry Username + |
+
+(Appears on:Template) +
+Container App scaling configurations.
+| Field | +Description | +
|---|---|
+maxReplicas+ +int + + |
+
+ MaxReplicas: Optional. Maximum number of container replicas. Defaults to 10 if not set. + |
+
+minReplicas+ +int + + |
+
+ MinReplicas: Optional. Minimum number of container replicas. + |
+
+rules+ + +[]ScaleRule + + + |
+
+ Rules: Scaling rules. + |
+
+(Appears on:Scale) +
+Container App container scaling rule.
+| Field | +Description | +
|---|---|
+azureQueue+ + +QueueScaleRule + + + |
+
+ AzureQueue: Azure Queue based scaling. + |
+
+custom+ + +CustomScaleRule + + + |
+
+ Custom: Custom scale rule. + |
+
+http+ + +HttpScaleRule + + + |
+
+ Http: HTTP requests based scaling. + |
+
+name+ +string + + |
+
+ Name: Scale Rule Name + |
+
+tcp+ + +TcpScaleRule + + + |
+
+ Tcp: Tcp requests based scaling. + |
+
+(Appears on:CustomScaleRule, HttpScaleRule, JobScaleRule, QueueScaleRule, TcpScaleRule) +
+Auth Secrets for Scale Rule
+| Field | +Description | +
|---|---|
+secretRef+ +string + + |
+
+ SecretRef: Name of the secret from which to pull the auth params. + |
+
+triggerParameter+ +string + + |
+
+ TriggerParameter: Trigger Parameter that uses the secret + |
+
+(Appears on:CustomScaleRule_STATUS, HttpScaleRule_STATUS, JobScaleRule_STATUS, QueueScaleRule_STATUS, TcpScaleRule_STATUS) +
+Auth Secrets for Scale Rule
+| Field | +Description | +
|---|---|
+secretRef+ +string + + |
+
+ SecretRef: Name of the secret from which to pull the auth params. + |
+
+triggerParameter+ +string + + |
+
+ TriggerParameter: Trigger Parameter that uses the secret + |
+
+(Appears on:Scale_STATUS) +
+Container App container scaling rule.
+| Field | +Description | +
|---|---|
+azureQueue+ + +QueueScaleRule_STATUS + + + |
+
+ AzureQueue: Azure Queue based scaling. + |
+
+custom+ + +CustomScaleRule_STATUS + + + |
+
+ Custom: Custom scale rule. + |
+
+http+ + +HttpScaleRule_STATUS + + + |
+
+ Http: HTTP requests based scaling. + |
+
+name+ +string + + |
+
+ Name: Scale Rule Name + |
+
+tcp+ + +TcpScaleRule_STATUS + + + |
+
+ Tcp: Tcp requests based scaling. + |
+
+(Appears on:Template_STATUS) +
+Container App scaling configurations.
+| Field | +Description | +
|---|---|
+maxReplicas+ +int + + |
+
+ MaxReplicas: Optional. Maximum number of container replicas. Defaults to 10 if not set. + |
+
+minReplicas+ +int + + |
+
+ MinReplicas: Optional. Minimum number of container replicas. + |
+
+rules+ + +[]ScaleRule_STATUS + + + |
+
+ Rules: Scaling rules. + |
+
+(Appears on:Configuration, JobConfiguration) +
+Secret definition.
+| Field | +Description | +
|---|---|
+identityReference+ + +genruntime.ResourceReference + + + |
+
+ IdentityReference: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a +system-assigned identity. + |
+
+keyVaultUrl+ +string + + |
+
+ KeyVaultUrl: Azure Key Vault URL pointing to the secret referenced by the container app. + |
+
+name+ +string + + |
+
+ Name: Secret Name. + |
+
+value+ + +genruntime.SecretReference + + + |
+
+ Value: Secret Value. + |
+
+(Appears on:Volume) +
+Secret to be added to volume.
+| Field | +Description | +
|---|---|
+path+ +string + + |
+
+ Path: Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. + |
+
+secretRef+ +string + + |
+
+ SecretRef: Name of the Container App secret from which to pull the secret value. + |
+
+(Appears on:Volume_STATUS) +
+Secret to be added to volume.
+| Field | +Description | +
|---|---|
+path+ +string + + |
+
+ Path: Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. + |
+
+secretRef+ +string + + |
+
+ SecretRef: Name of the Container App secret from which to pull the secret value. + |
+
+(Appears on:Configuration_STATUS, JobConfiguration_STATUS) +
+Secret definition.
+| Field | +Description | +
|---|---|
+identity+ +string + + |
+
+ Identity: Resource ID of a managed identity to authenticate with Azure Key Vault, or System to use a system-assigned +identity. + |
+
+keyVaultUrl+ +string + + |
+
+ KeyVaultUrl: Azure Key Vault URL pointing to the secret referenced by the container app. + |
+
+name+ +string + + |
+
+ Name: Secret Name. + |
+
+(Appears on:Configuration) +
+Container App to be a dev service
+| Field | +Description | +
|---|---|
+type+ +string + + |
+
+ Type: Dev ContainerApp service type + |
+
+(Appears on:Template) +
+Configuration to bind a ContainerApp to a dev ContainerApp Service
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: Name of the service bind + |
+
+serviceReference+ + +genruntime.ResourceReference + + + |
+
+ ServiceReference: Resource id of the target service + |
+
+(Appears on:Template_STATUS) +
+Configuration to bind a ContainerApp to a dev ContainerApp Service
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: Name of the service bind + |
+
+serviceId+ +string + + |
+
+ ServiceId: Resource id of the target service + |
+
+(Appears on:Configuration_STATUS) +
+Container App to be a dev service
+| Field | +Description | +
|---|---|
+type+ +string + + |
+
+ Type: Dev ContainerApp service type + |
+
string alias)+(Appears on:SystemData_STATUS) +
+| Value | +Description | +
|---|---|
"Application" |
++ |
"Key" |
++ |
"ManagedIdentity" |
++ |
"User" |
++ |
string alias)+(Appears on:SystemData_STATUS) +
+| Value | +Description | +
|---|---|
"Application" |
++ |
"Key" |
++ |
"ManagedIdentity" |
++ |
"User" |
++ |
+(Appears on:AuthConfig_STATUS, ContainerApp_STATUS, Job_STATUS, ManagedEnvironment_STATUS) +
+Metadata pertaining to creation and last modification of the resource.
+| Field | +Description | +
|---|---|
+createdAt+ +string + + |
+
+ CreatedAt: The timestamp of resource creation (UTC). + |
+
+createdBy+ +string + + |
+
+ CreatedBy: The identity that created the resource. + |
+
+createdByType+ + +SystemData_CreatedByType_STATUS + + + |
+
+ CreatedByType: The type of identity that created the resource. + |
+
+lastModifiedAt+ +string + + |
+
+ LastModifiedAt: The timestamp of resource last modification (UTC) + |
+
+lastModifiedBy+ +string + + |
+
+ LastModifiedBy: The identity that last modified the resource. + |
+
+lastModifiedByType+ + +SystemData_LastModifiedByType_STATUS + + + |
+
+ LastModifiedByType: The type of identity that last modified the resource. + |
+
+(Appears on:ScaleRule) +
+Container App container Tcp scaling rule.
+| Field | +Description | +
|---|---|
+auth+ + +[]ScaleRuleAuth + + + |
+
+ Auth: Authentication secrets for the tcp scale rule. + |
+
+metadata+ +map[string]string + + |
+
+ Metadata: Metadata properties to describe tcp scale rule. + |
+
+(Appears on:ScaleRule_STATUS) +
+Container App container Tcp scaling rule.
+| Field | +Description | +
|---|---|
+auth+ + +[]ScaleRuleAuth_STATUS + + + |
+
+ Auth: Authentication secrets for the tcp scale rule. + |
+
+metadata+ +map[string]string + + |
+
+ Metadata: Metadata properties to describe tcp scale rule. + |
+
+(Appears on:ContainerApp_Spec) +
+Container App versioned application definition. +Defines the desired state of an immutable revision. +Any changes to this +section Will result in a new revision being created
+| Field | +Description | +
|---|---|
+containers+ + +[]Container + + + |
+
+ Containers: List of container definitions for the Container App. + |
+
+initContainers+ + +[]BaseContainer + + + |
+
+ InitContainers: List of specialized containers that run before app containers. + |
+
+revisionSuffix+ +string + + |
+
+ RevisionSuffix: User friendly suffix that is appended to the revision name + |
+
+scale+ + +Scale + + + |
+
+ Scale: Scaling properties for the Container App. + |
+
+serviceBinds+ + +[]ServiceBind + + + |
+
+ ServiceBinds: List of container app services bound to the app + |
+
+terminationGracePeriodSeconds+ +int + + |
+
+ TerminationGracePeriodSeconds: Optional duration in seconds the Container App Instance needs to terminate gracefully. +Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to +shut down). If this value is nil, the default grace period will be used instead. Set this value longer than the expected +cleanup time for your process. Defaults to 30 seconds. + |
+
+volumes+ + +[]Volume + + + |
+
+ Volumes: List of volume definitions for the Container App. + |
+
+(Appears on:ContainerApp_STATUS) +
+Container App versioned application definition. +Defines the desired state of an immutable revision. +Any changes to this +section Will result in a new revision being created
+| Field | +Description | +
|---|---|
+containers+ + +[]Container_STATUS + + + |
+
+ Containers: List of container definitions for the Container App. + |
+
+initContainers+ + +[]BaseContainer_STATUS + + + |
+
+ InitContainers: List of specialized containers that run before app containers. + |
+
+revisionSuffix+ +string + + |
+
+ RevisionSuffix: User friendly suffix that is appended to the revision name + |
+
+scale+ + +Scale_STATUS + + + |
+
+ Scale: Scaling properties for the Container App. + |
+
+serviceBinds+ + +[]ServiceBind_STATUS + + + |
+
+ ServiceBinds: List of container app services bound to the app + |
+
+terminationGracePeriodSeconds+ +int + + |
+
+ TerminationGracePeriodSeconds: Optional duration in seconds the Container App Instance needs to terminate gracefully. +Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to +shut down). If this value is nil, the default grace period will be used instead. Set this value longer than the expected +cleanup time for your process. Defaults to 30 seconds. + |
+
+volumes+ + +[]Volume_STATUS + + + |
+
+ Volumes: List of volume definitions for the Container App. + |
+
+(Appears on:Login) +
+The configuration settings of the token store.
+| Field | +Description | +
|---|---|
+azureBlobStorage+ + +BlobStorageTokenStore + + + |
+
+ AzureBlobStorage: The configuration settings of the storage of the tokens if blob storage is used. + |
+
+enabled+ +bool + + |
+
+ Enabled: |
+
+tokenRefreshExtensionHours+ +float64 + + |
+
+ TokenRefreshExtensionHours: The number of hours after session token expiration that a session token can be used to +call the token refresh API. The default is 72 hours. + |
+
+(Appears on:Login_STATUS) +
+The configuration settings of the token store.
+| Field | +Description | +
|---|---|
+azureBlobStorage+ + +BlobStorageTokenStore_STATUS + + + |
+
+ AzureBlobStorage: The configuration settings of the storage of the tokens if blob storage is used. + |
+
+enabled+ +bool + + |
+
+ Enabled: |
+
+tokenRefreshExtensionHours+ +float64 + + |
+
+ TokenRefreshExtensionHours: The number of hours after session token expiration that a session token can be used to +call the token refresh API. The default is 72 hours. + |
+
+(Appears on:Ingress) +
+Traffic weight assigned to a revision
+| Field | +Description | +
|---|---|
+label+ +string + + |
+
+ Label: Associates a traffic label with a revision + |
+
+latestRevision+ +bool + + |
+
+ LatestRevision: Indicates that the traffic weight belongs to a latest stable revision + |
+
+revisionName+ +string + + |
+
+ RevisionName: Name of a revision + |
+
+weight+ +int + + |
+
+ Weight: Traffic weight assigned to a revision + |
+
+(Appears on:Ingress_STATUS) +
+Traffic weight assigned to a revision
+| Field | +Description | +
|---|---|
+label+ +string + + |
+
+ Label: Associates a traffic label with a revision + |
+
+latestRevision+ +bool + + |
+
+ LatestRevision: Indicates that the traffic weight belongs to a latest stable revision + |
+
+revisionName+ +string + + |
+
+ RevisionName: Name of a revision + |
+
+weight+ +int + + |
+
+ Weight: Traffic weight assigned to a revision + |
+
+(Appears on:IdentityProviders) +
+The configuration settings of the Twitter provider.
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: |
+
+registration+ + +TwitterRegistration + + + |
+
+ Registration: The configuration settings of the app registration for the Twitter provider. + |
+
+(Appears on:Twitter) +
+The configuration settings of the app registration for the Twitter provider.
+| Field | +Description | +
|---|---|
+consumerKey+ +string + + |
+
+ ConsumerKey: The OAuth 1.0a consumer key of the Twitter application used for sign-in. +This setting is required for enabling Twitter Sign-In. +Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in + |
+
+consumerSecretSettingName+ +string + + |
+
+ ConsumerSecretSettingName: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter +application used for sign-in. + |
+
+(Appears on:Twitter_STATUS) +
+The configuration settings of the app registration for the Twitter provider.
+| Field | +Description | +
|---|---|
+consumerKey+ +string + + |
+
+ ConsumerKey: The OAuth 1.0a consumer key of the Twitter application used for sign-in. +This setting is required for enabling Twitter Sign-In. +Twitter Sign-In documentation: https://dev.twitter.com/web/sign-in + |
+
+consumerSecretSettingName+ +string + + |
+
+ ConsumerSecretSettingName: The app setting name that contains the OAuth 1.0a consumer secret of the Twitter +application used for sign-in. + |
+
+(Appears on:IdentityProviders_STATUS) +
+The configuration settings of the Twitter provider.
+| Field | +Description | +
|---|---|
+enabled+ +bool + + |
+
+ Enabled: |
+
+registration+ + +TwitterRegistration_STATUS + + + |
+
+ Registration: The configuration settings of the app registration for the Twitter provider. + |
+
+(Appears on:ManagedServiceIdentity) +
+Information about the user assigned identity for the resource
+| Field | +Description | +
|---|---|
+reference+ + +genruntime.ResourceReference + + + |
++ | +
+(Appears on:ManagedServiceIdentity_STATUS) +
+User assigned identity properties
+| Field | +Description | +
|---|---|
+clientId+ +string + + |
+
+ ClientId: The client ID of the assigned identity. + |
+
+principalId+ +string + + |
+
+ PrincipalId: The principal ID of the assigned identity. + |
+
+(Appears on:ManagedEnvironment_Spec) +
+Configuration properties for apps environment to join a Virtual Network
+| Field | +Description | +
|---|---|
+dockerBridgeCidr+ +string + + |
+
+ DockerBridgeCidr: CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other +provided IP ranges. + |
+
+infrastructureSubnetReference+ + +genruntime.ResourceReference + + + |
+
+ InfrastructureSubnetReference: Resource ID of a subnet for infrastructure components. Must not overlap with any other +provided IP ranges. + |
+
+internal+ +bool + + |
+
+ Internal: Boolean indicating the environment only has an internal load balancer. These environments do not have a public +static IP resource. They must provide infrastructureSubnetId if enabling this property + |
+
+platformReservedCidr+ +string + + |
+
+ PlatformReservedCidr: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must +not overlap with any other provided IP ranges. + |
+
+platformReservedDnsIP+ +string + + |
+
+ PlatformReservedDnsIP: An IP address from the IP range defined by platformReservedCidr that will be reserved for the +internal DNS server. + |
+
+(Appears on:ManagedEnvironment_STATUS) +
+Configuration properties for apps environment to join a Virtual Network
+| Field | +Description | +
|---|---|
+dockerBridgeCidr+ +string + + |
+
+ DockerBridgeCidr: CIDR notation IP range assigned to the Docker bridge, network. Must not overlap with any other +provided IP ranges. + |
+
+infrastructureSubnetId+ +string + + |
+
+ InfrastructureSubnetId: Resource ID of a subnet for infrastructure components. Must not overlap with any other provided +IP ranges. + |
+
+internal+ +bool + + |
+
+ Internal: Boolean indicating the environment only has an internal load balancer. These environments do not have a public +static IP resource. They must provide infrastructureSubnetId if enabling this property + |
+
+platformReservedCidr+ +string + + |
+
+ PlatformReservedCidr: IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. Must +not overlap with any other provided IP ranges. + |
+
+platformReservedDnsIP+ +string + + |
+
+ PlatformReservedDnsIP: An IP address from the IP range defined by platformReservedCidr that will be reserved for the +internal DNS server. + |
+
+(Appears on:JobTemplate, Template) +
+Volume definitions for the Container App.
+| Field | +Description | +
|---|---|
+mountOptions+ +string + + |
+
+ MountOptions: Mount options used while mounting the AzureFile. Must be a comma-separated string. + |
+
+name+ +string + + |
+
+ Name: Volume name. + |
+
+secrets+ + +[]SecretVolumeItem + + + |
+
+ Secrets: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to +volume. + |
+
+storageName+ +string + + |
+
+ StorageName: Name of storage resource. No need to provide for EmptyDir and Secret. + |
+
+storageType+ + +Volume_StorageType + + + |
+
+ StorageType: Storage type for the volume. If not provided, use EmptyDir. + |
+
+(Appears on:BaseContainer, Container) +
+Volume mount for the Container App.
+| Field | +Description | +
|---|---|
+mountPath+ +string + + |
+
+ MountPath: Path within the container at which the volume should be mounted.Must not contain ‘:’. + |
+
+subPath+ +string + + |
+
+ SubPath: Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root). + |
+
+volumeName+ +string + + |
+
+ VolumeName: This must match the Name of a Volume. + |
+
+(Appears on:BaseContainer_STATUS, Container_STATUS) +
+Volume mount for the Container App.
+| Field | +Description | +
|---|---|
+mountPath+ +string + + |
+
+ MountPath: Path within the container at which the volume should be mounted.Must not contain ‘:’. + |
+
+subPath+ +string + + |
+
+ SubPath: Path within the volume from which the container’s volume should be mounted. Defaults to “” (volume’s root). + |
+
+volumeName+ +string + + |
+
+ VolumeName: This must match the Name of a Volume. + |
+
+(Appears on:JobTemplate_STATUS, Template_STATUS) +
+Volume definitions for the Container App.
+| Field | +Description | +
|---|---|
+mountOptions+ +string + + |
+
+ MountOptions: Mount options used while mounting the AzureFile. Must be a comma-separated string. + |
+
+name+ +string + + |
+
+ Name: Volume name. + |
+
+secrets+ + +[]SecretVolumeItem_STATUS + + + |
+
+ Secrets: List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to +volume. + |
+
+storageName+ +string + + |
+
+ StorageName: Name of storage resource. No need to provide for EmptyDir and Secret. + |
+
+storageType+ + +Volume_StorageType_STATUS + + + |
+
+ StorageType: Storage type for the volume. If not provided, use EmptyDir. + |
+
string alias)+(Appears on:Volume) +
+| Value | +Description | +
|---|---|
"AzureFile" |
++ |
"EmptyDir" |
++ |
"Secret" |
++ |
string alias)+(Appears on:Volume_STATUS) +
+| Value | +Description | +
|---|---|
"AzureFile" |
++ |
"EmptyDir" |
++ |
"Secret" |
++ |
+(Appears on:ManagedEnvironment_Spec) +
+Workload profile to scope container app execution.
+| Field | +Description | +
|---|---|
+maximumCount+ +int + + |
+
+ MaximumCount: The maximum capacity. + |
+
+minimumCount+ +int + + |
+
+ MinimumCount: The minimum capacity. + |
+
+name+ +string + + |
+
+ Name: Workload profile type for the workloads to run on. + |
+
+workloadProfileType+ +string + + |
+
+ WorkloadProfileType: Workload profile type for the workloads to run on. + |
+
+(Appears on:ManagedEnvironment_STATUS) +
+Workload profile to scope container app execution.
+| Field | +Description | +
|---|---|
+maximumCount+ +int + + |
+
+ MaximumCount: The maximum capacity. + |
+
+minimumCount+ +int + + |
+
+ MinimumCount: The minimum capacity. + |
+
+name+ +string + + |
+
+ Name: Workload profile type for the workloads to run on. + |
+
+workloadProfileType+ +string + + |
+
+ WorkloadProfileType: Workload profile type for the workloads to run on. + |
+
Package v1api20240815 contains API Schema definitions for the documentdb v1api20240815 API group
+string alias)| Value | +Description | +
|---|---|
"2024-08-15" |
++ |
+(Appears on:DatabaseAccountKeysMetadata_STATUS) +
+The metadata related to an access key for a given database account.
+| Field | +Description | +
|---|---|
+generationTime+ +string + + |
+
+ GenerationTime: Generation time in UTC of the key in ISO-8601 format. If the value is missing from the object, it means +that the last key regeneration was triggered before 2022-06-18. + |
+
+(Appears on:DatabaseAccount_Spec) +
+Analytical storage specific properties.
+| Field | +Description | +
|---|---|
+schemaType+ + +AnalyticalStorageSchemaType + + + |
+
+ SchemaType: Describes the types of schema for analytical storage. + |
+
+(Appears on:DatabaseAccount_STATUS) +
+Analytical storage specific properties.
+| Field | +Description | +
|---|---|
+schemaType+ + +AnalyticalStorageSchemaType_STATUS + + + |
+
+ SchemaType: Describes the types of schema for analytical storage. + |
+
string alias)+(Appears on:AnalyticalStorageConfiguration) +
+Describes the types of schema for analytical storage.
+| Value | +Description | +
|---|---|
"FullFidelity" |
++ |
"WellDefined" |
++ |
string alias)+(Appears on:AnalyticalStorageConfiguration_STATUS) +
+Describes the types of schema for analytical storage.
+| Value | +Description | +
|---|---|
"FullFidelity" |
++ |
"WellDefined" |
++ |
+(Appears on:DatabaseAccount_Spec) +
+| Field | +Description | +
|---|---|
+serverVersion+ + +ApiProperties_ServerVersion + + + |
+
+ ServerVersion: Describes the version of the MongoDB account. + |
+
+(Appears on:DatabaseAccount_STATUS) +
+| Field | +Description | +
|---|---|
+serverVersion+ + +ApiProperties_ServerVersion_STATUS + + + |
+
+ ServerVersion: Describes the version of the MongoDB account. + |
+
string alias)+(Appears on:ApiProperties) +
+| Value | +Description | +
|---|---|
"3.2" |
++ |
"3.6" |
++ |
"4.0" |
++ |
"4.2" |
++ |
"5.0" |
++ |
"6.0" |
++ |
"7.0" |
++ |
string alias)+(Appears on:ApiProperties_STATUS) +
+| Value | +Description | +
|---|---|
"3.2" |
++ |
"3.6" |
++ |
"4.0" |
++ |
"4.2" |
++ |
"5.0" |
++ |
"6.0" |
++ |
"7.0" |
++ |
+(Appears on:AutoscaleSettingsResource) +
+Cosmos DB resource auto-upgrade policy
+| Field | +Description | +
|---|---|
+throughputPolicy+ + +ThroughputPolicyResource + + + |
+
+ ThroughputPolicy: Represents throughput policy which service must adhere to for auto-upgrade + |
+
+(Appears on:AutoscaleSettingsResource_STATUS) +
+Cosmos DB resource auto-upgrade policy
+| Field | +Description | +
|---|---|
+throughputPolicy+ + +ThroughputPolicyResource_STATUS + + + |
+
+ ThroughputPolicy: Represents throughput policy which service must adhere to for auto-upgrade + |
+
+(Appears on:CreateUpdateOptions) +
+| Field | +Description | +
|---|---|
+maxThroughput+ +int + + |
+
+ MaxThroughput: Represents maximum throughput, the resource can scale up to. + |
+
+(Appears on:ThroughputSettingsResource) +
+Cosmos DB provisioned throughput settings object
+| Field | +Description | +
|---|---|
+autoUpgradePolicy+ + +AutoUpgradePolicyResource + + + |
+
+ AutoUpgradePolicy: Cosmos DB resource auto-upgrade policy + |
+
+maxThroughput+ +int + + |
+
+ MaxThroughput: Represents maximum throughput container can scale up to. + |
+
+(Appears on:ThroughputSettingsGetProperties_Resource_STATUS) +
+Cosmos DB provisioned throughput settings object
+| Field | +Description | +
|---|---|
+autoUpgradePolicy+ + +AutoUpgradePolicyResource_STATUS + + + |
+
+ AutoUpgradePolicy: Cosmos DB resource auto-upgrade policy + |
+
+maxThroughput+ +int + + |
+
+ MaxThroughput: Represents maximum throughput container can scale up to. + |
+
+targetMaxThroughput+ +int + + |
+
+ TargetMaxThroughput: Represents target maximum throughput container can scale up to once offer is no longer in pending +state. + |
+
+(Appears on:OptionsResource_STATUS) +
+| Field | +Description | +
|---|---|
+maxThroughput+ +int + + |
+
+ MaxThroughput: Represents maximum throughput, the resource can scale up to. + |
+
+(Appears on:DatabaseAccount_Spec) +
+| Field | +Description | +
|---|---|
+continuous+ + +ContinuousModeBackupPolicy + + + |
+
+ Continuous: Mutually exclusive with all other properties + |
+
+periodic+ + +PeriodicModeBackupPolicy + + + |
+
+ Periodic: Mutually exclusive with all other properties + |
+
+(Appears on:ContinuousModeBackupPolicy, PeriodicModeBackupPolicy) +
+The object representing the state of the migration between the backup policies.
+| Field | +Description | +
|---|---|
+startTime+ +string + + |
+
+ StartTime: Time at which the backup policy migration started (ISO-8601 format). + |
+
+status+ + +BackupPolicyMigrationStatus + + + |
+
+ Status: Describes the status of migration between backup policy types. + |
+
+targetType+ + +BackupPolicyType + + + |
+
+ TargetType: Describes the target backup policy type of the backup policy migration. + |
+
+(Appears on:ContinuousModeBackupPolicy_STATUS, PeriodicModeBackupPolicy_STATUS) +
+The object representing the state of the migration between the backup policies.
+| Field | +Description | +
|---|---|
+startTime+ +string + + |
+
+ StartTime: Time at which the backup policy migration started (ISO-8601 format). + |
+
+status+ + +BackupPolicyMigrationStatus_STATUS + + + |
+
+ Status: Describes the status of migration between backup policy types. + |
+
+targetType+ + +BackupPolicyType_STATUS + + + |
+
+ TargetType: Describes the target backup policy type of the backup policy migration. + |
+
string alias)+(Appears on:BackupPolicyMigrationState) +
+Describes the status of migration between backup policy types.
+| Value | +Description | +
|---|---|
"Completed" |
++ |
"Failed" |
++ |
"InProgress" |
++ |
"Invalid" |
++ |
string alias)+(Appears on:BackupPolicyMigrationState_STATUS) +
+Describes the status of migration between backup policy types.
+| Value | +Description | +
|---|---|
"Completed" |
++ |
"Failed" |
++ |
"InProgress" |
++ |
"Invalid" |
++ |
string alias)+(Appears on:BackupPolicyMigrationState) +
+Describes the mode of backups.
+| Value | +Description | +
|---|---|
"Continuous" |
++ |
"Periodic" |
++ |
string alias)+(Appears on:BackupPolicyMigrationState_STATUS) +
+Describes the mode of backups.
+| Value | +Description | +
|---|---|
"Continuous" |
++ |
"Periodic" |
++ |
+(Appears on:DatabaseAccount_STATUS) +
+| Field | +Description | +
|---|---|
+continuous+ + +ContinuousModeBackupPolicy_STATUS + + + |
+
+ Continuous: Mutually exclusive with all other properties + |
+
+periodic+ + +PeriodicModeBackupPolicy_STATUS + + + |
+
+ Periodic: Mutually exclusive with all other properties + |
+
string alias)+(Appears on:PeriodicModeProperties) +
+Enum to indicate type of backup storage redundancy.
+| Value | +Description | +
|---|---|
"Geo" |
++ |
"Local" |
++ |
"Zone" |
++ |
string alias)+(Appears on:PeriodicModeProperties_STATUS) +
+Enum to indicate type of backup storage redundancy.
+| Value | +Description | +
|---|---|
"Geo" |
++ |
"Local" |
++ |
"Zone" |
++ |
+(Appears on:DatabaseAccount_Spec) +
+Cosmos DB capability object
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: Name of the Cosmos DB capability. For example, “name”: “EnableCassandra”. Current values also include +“EnableTable” and “EnableGremlin”. + |
+
+(Appears on:DatabaseAccount_STATUS) +
+Cosmos DB capability object
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: Name of the Cosmos DB capability. For example, “name”: “EnableCassandra”. Current values also include +“EnableTable” and “EnableGremlin”. + |
+
+(Appears on:DatabaseAccount_Spec) +
+The object that represents all properties related to capacity enforcement on an account.
+| Field | +Description | +
|---|---|
+totalThroughputLimit+ +int + + |
+
+ TotalThroughputLimit: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict +limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no +limits on provisioning of throughput. + |
+
+(Appears on:DatabaseAccount_STATUS) +
+The object that represents all properties related to capacity enforcement on an account.
+| Field | +Description | +
|---|---|
+totalThroughputLimit+ +int + + |
+
+ TotalThroughputLimit: The total throughput limit imposed on the account. A totalThroughputLimit of 2000 imposes a strict +limit of max throughput that can be provisioned on that account to be 2000. A totalThroughputLimit of -1 indicates no +limits on provisioning of throughput. + |
+
+(Appears on:ClientEncryptionPolicy) +
+.
+| Field | +Description | +
|---|---|
+clientEncryptionKeyId+ +string + + |
+
+ ClientEncryptionKeyId: The identifier of the Client Encryption Key to be used to encrypt the path. + |
+
+encryptionAlgorithm+ +string + + |
+
+ EncryptionAlgorithm: The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256. + |
+
+encryptionType+ +string + + |
+
+ EncryptionType: The type of encryption to be performed. Eg - Deterministic, Randomized. + |
+
+path+ +string + + |
+
+ Path: Path that needs to be encrypted. + |
+
+(Appears on:ClientEncryptionPolicy_STATUS) +
+.
+| Field | +Description | +
|---|---|
+clientEncryptionKeyId+ +string + + |
+
+ ClientEncryptionKeyId: The identifier of the Client Encryption Key to be used to encrypt the path. + |
+
+encryptionAlgorithm+ +string + + |
+
+ EncryptionAlgorithm: The encryption algorithm which will be used. Eg - AEAD_AES_256_CBC_HMAC_SHA256. + |
+
+encryptionType+ +string + + |
+
+ EncryptionType: The type of encryption to be performed. Eg - Deterministic, Randomized. + |
+
+path+ +string + + |
+
+ Path: Path that needs to be encrypted. + |
+
+(Appears on:SqlContainerResource) +
+Cosmos DB client encryption policy.
+| Field | +Description | +
|---|---|
+includedPaths+ + +[]ClientEncryptionIncludedPath + + + |
+
+ IncludedPaths: Paths of the item that need encryption along with path-specific settings. + |
+
+policyFormatVersion+ +int + + |
+
+ PolicyFormatVersion: Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 +supports id and partition key path encryption. + |
+
+(Appears on:SqlContainerGetProperties_Resource_STATUS) +
+Cosmos DB client encryption policy.
+| Field | +Description | +
|---|---|
+includedPaths+ + +[]ClientEncryptionIncludedPath_STATUS + + + |
+
+ IncludedPaths: Paths of the item that need encryption along with path-specific settings. + |
+
+policyFormatVersion+ +int + + |
+
+ PolicyFormatVersion: Version of the client encryption policy definition. Supported versions are 1 and 2. Version 2 +supports id and partition key path encryption. + |
+
+(Appears on:IndexingPolicy) +
+| Field | +Description | +
|---|---|
+order+ + +CompositePath_Order + + + |
+
+ Order: Sort order for composite paths. + |
+
+path+ +string + + |
+
+ Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard +(/path/*) + |
+
string alias)+(Appears on:CompositePath) +
+| Value | +Description | +
|---|---|
"ascending" |
++ |
"descending" |
++ |
string alias)+(Appears on:CompositePath_STATUS) +
+| Value | +Description | +
|---|---|
"ascending" |
++ |
"descending" |
++ |
+(Appears on:IndexingPolicy_STATUS) +
+| Field | +Description | +
|---|---|
+order+ + +CompositePath_Order_STATUS + + + |
+
+ Order: Sort order for composite paths. + |
+
+path+ +string + + |
+
+ Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard +(/path/*) + |
+
+(Appears on:SqlContainerResource) +
+The definition of a computed property
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: The name of a computed property, for example - “cp_lowerName” + |
+
+query+ +string + + |
+
+ Query: The query that evaluates the value for computed property, for example - “SELECT VALUE LOWER(c.name) FROM c” + |
+
+(Appears on:SqlContainerGetProperties_Resource_STATUS) +
+The definition of a computed property
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: The name of a computed property, for example - “cp_lowerName” + |
+
+query+ +string + + |
+
+ Query: The query that evaluates the value for computed property, for example - “SELECT VALUE LOWER(c.name) FROM c” + |
+
+(Appears on:SqlContainerResource) +
+The conflict resolution policy for the container.
+| Field | +Description | +
|---|---|
+conflictResolutionPath+ +string + + |
+
+ ConflictResolutionPath: The conflict resolution path in the case of LastWriterWins mode. + |
+
+conflictResolutionProcedure+ +string + + |
+
+ ConflictResolutionProcedure: The procedure to resolve conflicts in the case of custom mode. + |
+
+mode+ + +ConflictResolutionPolicy_Mode + + + |
+
+ Mode: Indicates the conflict resolution mode. + |
+
string alias)+(Appears on:ConflictResolutionPolicy) +
+| Value | +Description | +
|---|---|
"Custom" |
++ |
"LastWriterWins" |
++ |
string alias)+(Appears on:ConflictResolutionPolicy_STATUS) +
+| Value | +Description | +
|---|---|
"Custom" |
++ |
"LastWriterWins" |
++ |
+(Appears on:SqlContainerGetProperties_Resource_STATUS) +
+The conflict resolution policy for the container.
+| Field | +Description | +
|---|---|
+conflictResolutionPath+ +string + + |
+
+ ConflictResolutionPath: The conflict resolution path in the case of LastWriterWins mode. + |
+
+conflictResolutionProcedure+ +string + + |
+
+ ConflictResolutionProcedure: The procedure to resolve conflicts in the case of custom mode. + |
+
+mode+ + +ConflictResolutionPolicy_Mode_STATUS + + + |
+
+ Mode: Indicates the conflict resolution mode. + |
+
string alias)+(Appears on:DatabaseAccount_Spec) +
+The cassandra connector offer type for the Cosmos DB C* database account.
+| Value | +Description | +
|---|---|
"Small" |
++ |
string alias)+(Appears on:DatabaseAccount_STATUS) +
+The cassandra connector offer type for the Cosmos DB C* database account.
+| Value | +Description | +
|---|---|
"Small" |
++ |
+(Appears on:DatabaseAccount_Spec) +
+The consistency policy for the Cosmos DB database account.
+| Field | +Description | +
|---|---|
+defaultConsistencyLevel+ + +ConsistencyPolicy_DefaultConsistencyLevel + + + |
+
+ DefaultConsistencyLevel: The default consistency level and configuration settings of the Cosmos DB account. + |
+
+maxIntervalInSeconds+ +int + + |
+
+ MaxIntervalInSeconds: When used with the Bounded Staleness consistency level, this value represents the time amount of +staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is +set to ‘BoundedStaleness’. + |
+
+maxStalenessPrefix+ +int + + |
+
+ MaxStalenessPrefix: When used with the Bounded Staleness consistency level, this value represents the number of stale +requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set +to ‘BoundedStaleness’. + |
+
string alias)+(Appears on:ConsistencyPolicy) +
+| Value | +Description | +
|---|---|
"BoundedStaleness" |
++ |
"ConsistentPrefix" |
++ |
"Eventual" |
++ |
"Session" |
++ |
"Strong" |
++ |
string alias)+(Appears on:ConsistencyPolicy_STATUS) +
+| Value | +Description | +
|---|---|
"BoundedStaleness" |
++ |
"ConsistentPrefix" |
++ |
"Eventual" |
++ |
"Session" |
++ |
"Strong" |
++ |
+(Appears on:DatabaseAccount_STATUS) +
+The consistency policy for the Cosmos DB database account.
+| Field | +Description | +
|---|---|
+defaultConsistencyLevel+ + +ConsistencyPolicy_DefaultConsistencyLevel_STATUS + + + |
+
+ DefaultConsistencyLevel: The default consistency level and configuration settings of the Cosmos DB account. + |
+
+maxIntervalInSeconds+ +int + + |
+
+ MaxIntervalInSeconds: When used with the Bounded Staleness consistency level, this value represents the time amount of +staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is +set to ‘BoundedStaleness’. + |
+
+maxStalenessPrefix+ +int + + |
+
+ MaxStalenessPrefix: When used with the Bounded Staleness consistency level, this value represents the number of stale +requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set +to ‘BoundedStaleness’. + |
+
+(Appears on:SqlContainerResource) +
+The configuration of the partition key to be used for partitioning data into multiple partitions
+| Field | +Description | +
|---|---|
+kind+ + +ContainerPartitionKey_Kind + + + |
+
+ Kind: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) +are supported for container create + |
+
+paths+ +[]string + + |
+
+ Paths: List of paths using which data within the container can be partitioned + |
+
+version+ +int + + |
+
+ Version: Indicates the version of the partition key definition + |
+
string alias)+(Appears on:ContainerPartitionKey) +
+| Value | +Description | +
|---|---|
"Hash" |
++ |
"MultiHash" |
++ |
"Range" |
++ |
string alias)+(Appears on:ContainerPartitionKey_STATUS) +
+| Value | +Description | +
|---|---|
"Hash" |
++ |
"MultiHash" |
++ |
"Range" |
++ |
+(Appears on:SqlContainerGetProperties_Resource_STATUS) +
+The configuration of the partition key to be used for partitioning data into multiple partitions
+| Field | +Description | +
|---|---|
+kind+ + +ContainerPartitionKey_Kind_STATUS + + + |
+
+ Kind: Indicates the kind of algorithm used for partitioning. For MultiHash, multiple partition keys (upto three maximum) +are supported for container create + |
+
+paths+ +[]string + + |
+
+ Paths: List of paths using which data within the container can be partitioned + |
+
+systemKey+ +bool + + |
+
+ SystemKey: Indicates if the container is using a system generated partition key + |
+
+version+ +int + + |
+
+ Version: Indicates the version of the partition key definition + |
+
+(Appears on:BackupPolicy) +
+| Field | +Description | +
|---|---|
+continuousModeProperties+ + +ContinuousModeProperties + + + |
+
+ ContinuousModeProperties: Configuration values for continuous mode backup + |
+
+migrationState+ + +BackupPolicyMigrationState + + + |
+
+ MigrationState: The object representing the state of the migration between the backup policies. + |
+
+type+ + +ContinuousModeBackupPolicy_Type + + + |
+
+ Type: Describes the mode of backups. + |
+
+(Appears on:BackupPolicy_STATUS) +
+| Field | +Description | +
|---|---|
+continuousModeProperties+ + +ContinuousModeProperties_STATUS + + + |
+
+ ContinuousModeProperties: Configuration values for continuous mode backup + |
+
+migrationState+ + +BackupPolicyMigrationState_STATUS + + + |
+
+ MigrationState: The object representing the state of the migration between the backup policies. + |
+
+type+ + +ContinuousModeBackupPolicy_Type_STATUS + + + |
+
+ Type: Describes the mode of backups. + |
+
string alias)+(Appears on:ContinuousModeBackupPolicy) +
+| Value | +Description | +
|---|---|
"Continuous" |
++ |
string alias)+(Appears on:ContinuousModeBackupPolicy_STATUS) +
+| Value | +Description | +
|---|---|
"Continuous" |
++ |
+(Appears on:ContinuousModeBackupPolicy) +
+Configuration values for periodic mode backup
+| Field | +Description | +
|---|---|
+tier+ + +ContinuousTier + + + |
+
+ Tier: Enum to indicate type of Continuous backup mode + |
+
+(Appears on:ContinuousModeBackupPolicy_STATUS) +
+Configuration values for periodic mode backup
+| Field | +Description | +
|---|---|
+tier+ + +ContinuousTier_STATUS + + + |
+
+ Tier: Enum to indicate type of Continuous backup mode + |
+
string alias)+(Appears on:ContinuousModeProperties) +
+Enum to indicate type of Continuous backup tier.
+| Value | +Description | +
|---|---|
"Continuous30Days" |
++ |
"Continuous7Days" |
++ |
string alias)+(Appears on:ContinuousModeProperties_STATUS) +
+Enum to indicate type of Continuous backup tier.
+| Value | +Description | +
|---|---|
"Continuous30Days" |
++ |
"Continuous7Days" |
++ |
+(Appears on:DatabaseAccount_Spec) +
+The CORS policy for the Cosmos DB database account.
+| Field | +Description | +
|---|---|
+allowedHeaders+ +string + + |
+
+ AllowedHeaders: The request headers that the origin domain may specify on the CORS request. + |
+
+allowedMethods+ +string + + |
+
+ AllowedMethods: The methods (HTTP request verbs) that the origin domain may use for a CORS request. + |
+
+allowedOrigins+ +string + + |
+
+ AllowedOrigins: The origin domains that are permitted to make a request against the service via CORS. + |
+
+exposedHeaders+ +string + + |
+
+ ExposedHeaders: The response headers that may be sent in the response to the CORS request and exposed by the browser to +the request issuer. + |
+
+maxAgeInSeconds+ +int + + |
+
+ MaxAgeInSeconds: The maximum amount time that a browser should cache the preflight OPTIONS request. + |
+
+(Appears on:DatabaseAccount_STATUS) +
+The CORS policy for the Cosmos DB database account.
+| Field | +Description | +
|---|---|
+allowedHeaders+ +string + + |
+
+ AllowedHeaders: The request headers that the origin domain may specify on the CORS request. + |
+
+allowedMethods+ +string + + |
+
+ AllowedMethods: The methods (HTTP request verbs) that the origin domain may use for a CORS request. + |
+
+allowedOrigins+ +string + + |
+
+ AllowedOrigins: The origin domains that are permitted to make a request against the service via CORS. + |
+
+exposedHeaders+ +string + + |
+
+ ExposedHeaders: The response headers that may be sent in the response to the CORS request and exposed by the browser to +the request issuer. + |
+
+maxAgeInSeconds+ +int + + |
+
+ MaxAgeInSeconds: The maximum amount time that a browser should cache the preflight OPTIONS request. + |
+
string alias)+(Appears on:DatabaseAccount_Spec, MongoDBCollectionResource, MongoDBDatabaseResource, SqlContainerResource, SqlDatabaseResource) +
+Enum to indicate the mode of account creation.
+| Value | +Description | +
|---|---|
"Default" |
++ |
"Restore" |
++ |
string alias)+(Appears on:DatabaseAccount_STATUS, MongoDBCollectionGetProperties_Resource_STATUS, MongoDBDatabaseGetProperties_Resource_STATUS, SqlContainerGetProperties_Resource_STATUS, SqlDatabaseGetProperties_Resource_STATUS) +
+Enum to indicate the mode of account creation.
+| Value | +Description | +
|---|---|
"Default" |
++ |
"Restore" |
++ |
+(Appears on:MongodbDatabaseCollection_Spec, MongodbDatabase_Spec, SqlDatabaseContainerStoredProcedure_Spec, SqlDatabaseContainerTrigger_Spec, SqlDatabaseContainerUserDefinedFunction_Spec, SqlDatabaseContainer_Spec, SqlDatabase_Spec) +
+CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are “If-Match”, +“If-None-Match”, “Session-Token” and “Throughput”
+| Field | +Description | +
|---|---|
+autoscaleSettings+ + +AutoscaleSettings + + + |
+
+ AutoscaleSettings: Specifies the Autoscale settings. Note: Either throughput or autoscaleSettings is required, but not +both. + |
+
+throughput+ +int + + |
+
+ Throughput: Request Units per second. For example, “throughput”: 10000. + |
+
Generator information: +- Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-08-15/cosmos-db.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName} +
| Field | +Description | +||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+spec+ + +DatabaseAccount_Spec + + + |
+
+ + +
|
+||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
+status+ + +DatabaseAccount_STATUS + + + |
++ | +
+(Appears on:DatabaseAccount_STATUS) +
+The metadata related to each access key for the given Cosmos DB database account.
+| Field | +Description | +
|---|---|
+primaryMasterKey+ + +AccountKeyMetadata_STATUS + + + |
+
+ PrimaryMasterKey: The metadata related to the Primary Read-Write Key for the given Cosmos DB database account. + |
+
+primaryReadonlyMasterKey+ + +AccountKeyMetadata_STATUS + + + |
+
+ PrimaryReadonlyMasterKey: The metadata related to the Primary Read-Only Key for the given Cosmos DB database account. + |
+
+secondaryMasterKey+ + +AccountKeyMetadata_STATUS + + + |
+
+ SecondaryMasterKey: The metadata related to the Secondary Read-Write Key for the given Cosmos DB database account. + |
+
+secondaryReadonlyMasterKey+ + +AccountKeyMetadata_STATUS + + + |
+
+ SecondaryReadonlyMasterKey: The metadata related to the Secondary Read-Only Key for the given Cosmos DB database account. + |
+
string alias)+(Appears on:DatabaseAccount_Spec) +
+The offer type for the Cosmos DB database account.
+| Value | +Description | +
|---|---|
"Standard" |
++ |
string alias)+(Appears on:DatabaseAccount_STATUS) +
+The offer type for the Cosmos DB database account.
+| Value | +Description | +
|---|---|
"Standard" |
++ |
+(Appears on:DatabaseAccountOperatorSpec) +
+| Field | +Description | +
|---|---|
+documentEndpoint+ + +genruntime.SecretDestination + + + |
+
+ DocumentEndpoint: indicates where the DocumentEndpoint secret should be placed. If omitted, the secret will not be +retrieved from Azure. + |
+
+primaryMasterKey+ + +genruntime.SecretDestination + + + |
+
+ PrimaryMasterKey: indicates where the PrimaryMasterKey secret should be placed. If omitted, the secret will not be +retrieved from Azure. + |
+
+primaryReadonlyMasterKey+ + +genruntime.SecretDestination + + + |
+
+ PrimaryReadonlyMasterKey: indicates where the PrimaryReadonlyMasterKey secret should be placed. If omitted, the secret +will not be retrieved from Azure. + |
+
+secondaryMasterKey+ + +genruntime.SecretDestination + + + |
+
+ SecondaryMasterKey: indicates where the SecondaryMasterKey secret should be placed. If omitted, the secret will not be +retrieved from Azure. + |
+
+secondaryReadonlyMasterKey+ + +genruntime.SecretDestination + + + |
+
+ SecondaryReadonlyMasterKey: indicates where the SecondaryReadonlyMasterKey secret should be placed. If omitted, the +secret will not be retrieved from Azure. + |
+
+(Appears on:DatabaseAccount_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+secrets+ + +DatabaseAccountOperatorSecrets + + + |
+
+ Secrets: configures where to place Azure generated secrets. + |
+
string alias)+(Appears on:DatabaseAccount_STATUS) +
+| Value | +Description | +
|---|---|
"GlobalDocumentDB" |
++ |
"MongoDB" |
++ |
"Parse" |
++ |
string alias)+(Appears on:DatabaseAccount_Spec) +
+| Value | +Description | +
|---|---|
"GlobalDocumentDB" |
++ |
"MongoDB" |
++ |
"Parse" |
++ |
+(Appears on:DatabaseAccount) +
+| Field | +Description | +
|---|---|
+analyticalStorageConfiguration+ + +AnalyticalStorageConfiguration_STATUS + + + |
+
+ AnalyticalStorageConfiguration: Analytical storage specific properties. + |
+
+apiProperties+ + +ApiProperties_STATUS + + + |
+
+ ApiProperties: API specific properties. + |
+
+backupPolicy+ + +BackupPolicy_STATUS + + + |
+
+ BackupPolicy: The object representing the policy for taking backups on an account. + |
+
+capabilities+ + +[]Capability_STATUS + + + |
+
+ Capabilities: List of Cosmos DB capabilities for the account + |
+
+capacity+ + +Capacity_STATUS + + + |
+
+ Capacity: The object that represents all properties related to capacity enforcement on an account. + |
+
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+connectorOffer+ + +ConnectorOffer_STATUS + + + |
+
+ ConnectorOffer: The cassandra connector offer type for the Cosmos DB database C* account. + |
+
+consistencyPolicy+ + +ConsistencyPolicy_STATUS + + + |
+
+ ConsistencyPolicy: The consistency policy for the Cosmos DB database account. + |
+
+cors+ + +[]CorsPolicy_STATUS + + + |
+
+ Cors: The CORS policy for the Cosmos DB database account. + |
+
+createMode+ + +CreateMode_STATUS + + + |
+
+ CreateMode: Enum to indicate the mode of account creation. + |
+
+customerManagedKeyStatus+ +string + + |
+
+ CustomerManagedKeyStatus: Indicates the status of the Customer Managed Key feature on the account. In case there are +errors, the property provides troubleshooting guidance. + |
+
+databaseAccountOfferType+ + +DatabaseAccountOfferType_STATUS + + + |
+
+ DatabaseAccountOfferType: The offer type for the Cosmos DB database account. Default value: Standard. + |
+
+defaultIdentity+ +string + + |
+
+ DefaultIdentity: The default identity for accessing key vault used in features like customer managed keys. The default +identity needs to be explicitly set by the users. It can be “FirstPartyIdentity”, “SystemAssignedIdentity” and more. + |
+
+disableKeyBasedMetadataWriteAccess+ +bool + + |
+
+ DisableKeyBasedMetadataWriteAccess: Disable write operations on metadata resources (databases, containers, throughput) +via account keys + |
+
+disableLocalAuth+ +bool + + |
+
+ DisableLocalAuth: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. + |
+
+documentEndpoint+ +string + + |
+
+ DocumentEndpoint: The connection endpoint for the Cosmos DB database account. + |
+
+enableAnalyticalStorage+ +bool + + |
+
+ EnableAnalyticalStorage: Flag to indicate whether to enable storage analytics. + |
+
+enableAutomaticFailover+ +bool + + |
+
+ EnableAutomaticFailover: Enables automatic failover of the write region in the rare event that the region is unavailable +due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the +failover priorities configured for the account. + |
+
+enableBurstCapacity+ +bool + + |
+
+ EnableBurstCapacity: Flag to indicate enabling/disabling of Burst Capacity feature on the account + |
+
+enableCassandraConnector+ +bool + + |
+
+ EnableCassandraConnector: Enables the cassandra connector on the Cosmos DB C* account + |
+
+enableFreeTier+ +bool + + |
+
+ EnableFreeTier: Flag to indicate whether Free Tier is enabled. + |
+
+enableMultipleWriteLocations+ +bool + + |
+
+ EnableMultipleWriteLocations: Enables the account to write in multiple locations + |
+
+enablePartitionMerge+ +bool + + |
+
+ EnablePartitionMerge: Flag to indicate enabling/disabling of Partition Merge feature on the account + |
+
+failoverPolicies+ + +[]FailoverPolicy_STATUS + + + |
+
+ FailoverPolicies: An array that contains the regions ordered by their failover priorities. + |
+
+id+ +string + + |
+
+ Id: The unique resource identifier of the ARM resource. + |
+
+identity+ + +ManagedServiceIdentity_STATUS + + + |
+
+ Identity: Identity for the resource. + |
+
+instanceId+ +string + + |
+
+ InstanceId: A unique identifier assigned to the database account + |
+
+ipRules+ + +[]IpAddressOrRange_STATUS + + + |
+
+ IpRules: List of IpRules. + |
+
+isVirtualNetworkFilterEnabled+ +bool + + |
+
+ IsVirtualNetworkFilterEnabled: Flag to indicate whether to enable/disable Virtual Network ACL rules. + |
+
+keyVaultKeyUri+ +string + + |
+
+ KeyVaultKeyUri: The URI of the key vault + |
+
+keysMetadata+ + +DatabaseAccountKeysMetadata_STATUS + + + |
+
+ KeysMetadata: The object that represents the metadata for the Account Keys of the Cosmos DB account. + |
+
+kind+ + +DatabaseAccount_Kind_STATUS + + + |
+
+ Kind: Indicates the type of database account. This can only be set at database account creation. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+locations+ + +[]Location_STATUS + + + |
+
+ Locations: An array that contains all of the locations enabled for the Cosmos DB account. + |
+
+minimalTlsVersion+ + +MinimalTlsVersion_STATUS + + + |
+
+ MinimalTlsVersion: Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs +only work with Tls 1.2. + |
+
+name+ +string + + |
+
+ Name: The name of the ARM resource. + |
+
+networkAclBypass+ + +NetworkAclBypass_STATUS + + + |
+
+ NetworkAclBypass: Indicates what services are allowed to bypass firewall checks. + |
+
+networkAclBypassResourceIds+ +[]string + + |
+
+ NetworkAclBypassResourceIds: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB account. + |
+
+privateEndpointConnections+ + +[]PrivateEndpointConnection_STATUS + + + |
+
+ PrivateEndpointConnections: List of Private Endpoint Connections configured for the Cosmos DB account. + |
+
+provisioningState+ +string + + |
++ | +
+publicNetworkAccess+ + +PublicNetworkAccess_STATUS + + + |
+
+ PublicNetworkAccess: Whether requests from Public Network are allowed + |
+
+readLocations+ + +[]Location_STATUS + + + |
+
+ ReadLocations: An array that contains of the read locations enabled for the Cosmos DB account. + |
+
+restoreParameters+ + +RestoreParameters_STATUS + + + |
+
+ RestoreParameters: Parameters to indicate the information about the restore. + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: The system meta data relating to this resource. + |
+
+tags+ +map[string]string + + |
++ | +
+type+ +string + + |
+
+ Type: The type of Azure resource. + |
+
+virtualNetworkRules+ + +[]VirtualNetworkRule_STATUS + + + |
+
+ VirtualNetworkRules: List of Virtual Network ACL rules configured for the Cosmos DB account. + |
+
+writeLocations+ + +[]Location_STATUS + + + |
+
+ WriteLocations: An array that contains the write location for the Cosmos DB account. + |
+
+(Appears on:DatabaseAccount) +
+| Field | +Description | +
|---|---|
+analyticalStorageConfiguration+ + +AnalyticalStorageConfiguration + + + |
+
+ AnalyticalStorageConfiguration: Analytical storage specific properties. + |
+
+apiProperties+ + +ApiProperties + + + |
+
+ ApiProperties: API specific properties. Currently, supported only for MongoDB API. + |
+
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+backupPolicy+ + +BackupPolicy + + + |
+
+ BackupPolicy: The object representing the policy for taking backups on an account. + |
+
+capabilities+ + +[]Capability + + + |
+
+ Capabilities: List of Cosmos DB capabilities for the account + |
+
+capacity+ + +Capacity + + + |
+
+ Capacity: The object that represents all properties related to capacity enforcement on an account. + |
+
+connectorOffer+ + +ConnectorOffer + + + |
+
+ ConnectorOffer: The cassandra connector offer type for the Cosmos DB database C* account. + |
+
+consistencyPolicy+ + +ConsistencyPolicy + + + |
+
+ ConsistencyPolicy: The consistency policy for the Cosmos DB account. + |
+
+cors+ + +[]CorsPolicy + + + |
+
+ Cors: The CORS policy for the Cosmos DB database account. + |
+
+createMode+ + +CreateMode + + + |
+
+ CreateMode: Enum to indicate the mode of account creation. + |
+
+customerManagedKeyStatus+ +string + + |
+
+ CustomerManagedKeyStatus: Indicates the status of the Customer Managed Key feature on the account. In case there are +errors, the property provides troubleshooting guidance. + |
+
+databaseAccountOfferType+ + +DatabaseAccountOfferType + + + |
+
+ DatabaseAccountOfferType: The offer type for the database + |
+
+defaultIdentity+ +string + + |
+
+ DefaultIdentity: The default identity for accessing key vault used in features like customer managed keys. The default +identity needs to be explicitly set by the users. It can be “FirstPartyIdentity”, “SystemAssignedIdentity” and more. + |
+
+disableKeyBasedMetadataWriteAccess+ +bool + + |
+
+ DisableKeyBasedMetadataWriteAccess: Disable write operations on metadata resources (databases, containers, throughput) +via account keys + |
+
+disableLocalAuth+ +bool + + |
+
+ DisableLocalAuth: Opt-out of local authentication and ensure only MSI and AAD can be used exclusively for authentication. + |
+
+enableAnalyticalStorage+ +bool + + |
+
+ EnableAnalyticalStorage: Flag to indicate whether to enable storage analytics. + |
+
+enableAutomaticFailover+ +bool + + |
+
+ EnableAutomaticFailover: Enables automatic failover of the write region in the rare event that the region is unavailable +due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the +failover priorities configured for the account. + |
+
+enableBurstCapacity+ +bool + + |
+
+ EnableBurstCapacity: Flag to indicate enabling/disabling of Burst Capacity feature on the account + |
+
+enableCassandraConnector+ +bool + + |
+
+ EnableCassandraConnector: Enables the cassandra connector on the Cosmos DB C* account + |
+
+enableFreeTier+ +bool + + |
+
+ EnableFreeTier: Flag to indicate whether Free Tier is enabled. + |
+
+enableMultipleWriteLocations+ +bool + + |
+
+ EnableMultipleWriteLocations: Enables the account to write in multiple locations + |
+
+enablePartitionMerge+ +bool + + |
+
+ EnablePartitionMerge: Flag to indicate enabling/disabling of Partition Merge feature on the account + |
+
+identity+ + +ManagedServiceIdentity + + + |
+
+ Identity: Identity for the resource. + |
+
+ipRules+ + +[]IpAddressOrRange + + + |
+
+ IpRules: List of IpRules. + |
+
+isVirtualNetworkFilterEnabled+ +bool + + |
+
+ IsVirtualNetworkFilterEnabled: Flag to indicate whether to enable/disable Virtual Network ACL rules. + |
+
+keyVaultKeyUri+ +string + + |
+
+ KeyVaultKeyUri: The URI of the key vault + |
+
+kind+ + +DatabaseAccount_Kind_Spec + + + |
+
+ Kind: Indicates the type of database account. This can only be set at database account creation. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+locations+ + +[]Location + + + |
+
+ Locations: An array that contains the georeplication locations enabled for the Cosmos DB account. + |
+
+minimalTlsVersion+ + +MinimalTlsVersion + + + |
+
+ MinimalTlsVersion: Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs +only work with Tls 1.2. + |
+
+networkAclBypass+ + +NetworkAclBypass + + + |
+
+ NetworkAclBypass: Indicates what services are allowed to bypass firewall checks. + |
+
+networkAclBypassResourceReferences+ + +[]genruntime.ResourceReference + + + |
+
+ NetworkAclBypassResourceReferences: An array that contains the Resource Ids for Network Acl Bypass for the Cosmos DB +account. + |
+
+operatorSpec+ + +DatabaseAccountOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a resources.azure.com/ResourceGroup resource + |
+
+publicNetworkAccess+ + +PublicNetworkAccess + + + |
+
+ PublicNetworkAccess: Whether requests from Public Network are allowed + |
+
+restoreParameters+ + +RestoreParameters + + + |
+
+ RestoreParameters: Parameters to indicate the information about the restore. + |
+
+tags+ +map[string]string + + |
++ | +
+virtualNetworkRules+ + +[]VirtualNetworkRule + + + |
+
+ VirtualNetworkRules: List of Virtual Network ACL rules configured for the Cosmos DB account. + |
+
+(Appears on:RestoreParameters) +
+Specific Databases to restore.
+| Field | +Description | +
|---|---|
+collectionNames+ +[]string + + |
+
+ CollectionNames: The names of the collections available for restore. + |
+
+databaseName+ +string + + |
+
+ DatabaseName: The name of the database available for restore. + |
+
+(Appears on:RestoreParameters_STATUS) +
+Specific Databases to restore.
+| Field | +Description | +
|---|---|
+collectionNames+ +[]string + + |
+
+ CollectionNames: The names of the collections available for restore. + |
+
+databaseName+ +string + + |
+
+ DatabaseName: The name of the database available for restore. + |
+
+(Appears on:IndexingPolicy) +
+| Field | +Description | +
|---|---|
+path+ +string + + |
+
+ Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard +(/path/*) + |
+
+(Appears on:IndexingPolicy_STATUS) +
+| Field | +Description | +
|---|---|
+path+ +string + + |
+
+ Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard +(/path/*) + |
+
+(Appears on:DatabaseAccount_STATUS) +
+The failover policy for a given region of a database account.
+| Field | +Description | +
|---|---|
+failoverPriority+ +int + + |
+
+ FailoverPriority: The failover priority of the region. A failover priority of 0 indicates a write region. The maximum +value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the +regions in which the database account exists. + |
+
+id+ +string + + |
+
+ Id: The unique identifier of the region in which the database account replicates to. Example: +<accountName>-<locationName>. + |
+
+locationName+ +string + + |
+
+ LocationName: The name of the region in which the database account exists. + |
+
+(Appears on:RestoreParameters) +
+Specific Gremlin Databases to restore.
+| Field | +Description | +
|---|---|
+databaseName+ +string + + |
+
+ DatabaseName: The name of the gremlin database available for restore. + |
+
+graphNames+ +[]string + + |
+
+ GraphNames: The names of the graphs available for restore. + |
+
+(Appears on:RestoreParameters_STATUS) +
+Specific Gremlin Databases to restore.
+| Field | +Description | +
|---|---|
+databaseName+ +string + + |
+
+ DatabaseName: The name of the gremlin database available for restore. + |
+
+graphNames+ +[]string + + |
+
+ GraphNames: The names of the graphs available for restore. + |
+
+(Appears on:IndexingPolicy) +
+The paths that are included in indexing
+| Field | +Description | +
|---|---|
+indexes+ + +[]Indexes + + + |
+
+ Indexes: List of indexes for this path + |
+
+path+ +string + + |
+
+ Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard +(/path/*) + |
+
+(Appears on:IndexingPolicy_STATUS) +
+The paths that are included in indexing
+| Field | +Description | +
|---|---|
+indexes+ + +[]Indexes_STATUS + + + |
+
+ Indexes: List of indexes for this path + |
+
+path+ +string + + |
+
+ Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard +(/path/*) + |
+
+(Appears on:IncludedPath) +
+The indexes for the path.
+| Field | +Description | +
|---|---|
+dataType+ + +Indexes_DataType + + + |
+
+ DataType: The datatype for which the indexing behavior is applied to. + |
+
+kind+ + +Indexes_Kind + + + |
+
+ Kind: Indicates the type of index. + |
+
+precision+ +int + + |
+
+ Precision: The precision of the index. -1 is maximum precision. + |
+
string alias)+(Appears on:Indexes) +
+| Value | +Description | +
|---|---|
"LineString" |
++ |
"MultiPolygon" |
++ |
"Number" |
++ |
"Point" |
++ |
"Polygon" |
++ |
"String" |
++ |
string alias)+(Appears on:Indexes_STATUS) +
+| Value | +Description | +
|---|---|
"LineString" |
++ |
"MultiPolygon" |
++ |
"Number" |
++ |
"Point" |
++ |
"Polygon" |
++ |
"String" |
++ |
string alias)+(Appears on:Indexes) +
+| Value | +Description | +
|---|---|
"Hash" |
++ |
"Range" |
++ |
"Spatial" |
++ |
string alias)+(Appears on:Indexes_STATUS) +
+| Value | +Description | +
|---|---|
"Hash" |
++ |
"Range" |
++ |
"Spatial" |
++ |
+(Appears on:IncludedPath_STATUS) +
+The indexes for the path.
+| Field | +Description | +
|---|---|
+dataType+ + +Indexes_DataType_STATUS + + + |
+
+ DataType: The datatype for which the indexing behavior is applied to. + |
+
+kind+ + +Indexes_Kind_STATUS + + + |
+
+ Kind: Indicates the type of index. + |
+
+precision+ +int + + |
+
+ Precision: The precision of the index. -1 is maximum precision. + |
+
+(Appears on:SqlContainerResource) +
+Cosmos DB indexing policy
+| Field | +Description | +
|---|---|
+automatic+ +bool + + |
+
+ Automatic: Indicates if the indexing policy is automatic + |
+
+compositeIndexes+ + +[]CompositePath + + + |
+
+ CompositeIndexes: List of composite path list + |
+
+excludedPaths+ + +[]ExcludedPath + + + |
+
+ ExcludedPaths: List of paths to exclude from indexing + |
+
+includedPaths+ + +[]IncludedPath + + + |
+
+ IncludedPaths: List of paths to include in the indexing + |
+
+indexingMode+ + +IndexingPolicy_IndexingMode + + + |
+
+ IndexingMode: Indicates the indexing mode. + |
+
+spatialIndexes+ + +[]SpatialSpec + + + |
+
+ SpatialIndexes: List of spatial specifics + |
+
string alias)+(Appears on:IndexingPolicy) +
+| Value | +Description | +
|---|---|
"consistent" |
++ |
"lazy" |
++ |
"none" |
++ |
string alias)+(Appears on:IndexingPolicy_STATUS) +
+| Value | +Description | +
|---|---|
"consistent" |
++ |
"lazy" |
++ |
"none" |
++ |
+(Appears on:SqlContainerGetProperties_Resource_STATUS) +
+Cosmos DB indexing policy
+| Field | +Description | +
|---|---|
+automatic+ +bool + + |
+
+ Automatic: Indicates if the indexing policy is automatic + |
+
+compositeIndexes+ + +[]CompositePath_STATUS + + + |
+
+ CompositeIndexes: List of composite path list + |
+
+excludedPaths+ + +[]ExcludedPath_STATUS + + + |
+
+ ExcludedPaths: List of paths to exclude from indexing + |
+
+includedPaths+ + +[]IncludedPath_STATUS + + + |
+
+ IncludedPaths: List of paths to include in the indexing + |
+
+indexingMode+ + +IndexingPolicy_IndexingMode_STATUS + + + |
+
+ IndexingMode: Indicates the indexing mode. + |
+
+spatialIndexes+ + +[]SpatialSpec_STATUS + + + |
+
+ SpatialIndexes: List of spatial specifics + |
+
+(Appears on:DatabaseAccount_Spec) +
+IpAddressOrRange object
+| Field | +Description | +
|---|---|
+ipAddressOrRange+ +string + + |
+
+ IpAddressOrRange: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be +well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, +192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” +or “23.40.210.0/8”. + |
+
+(Appears on:DatabaseAccount_STATUS) +
+IpAddressOrRange object
+| Field | +Description | +
|---|---|
+ipAddressOrRange+ +string + + |
+
+ IpAddressOrRange: A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be +well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, +192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” +or “23.40.210.0/8”. + |
+
+(Appears on:DatabaseAccount_Spec) +
+A region in which the Azure Cosmos DB database account is deployed.
+| Field | +Description | +
|---|---|
+failoverPriority+ +int + + |
+
+ FailoverPriority: The failover priority of the region. A failover priority of 0 indicates a write region. The maximum +value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the +regions in which the database account exists. + |
+
+isZoneRedundant+ +bool + + |
+
+ IsZoneRedundant: Flag to indicate whether or not this region is an AvailabilityZone region + |
+
+locationName+ +string + + |
+
+ LocationName: The name of the region. + |
+
+(Appears on:DatabaseAccount_STATUS) +
+A region in which the Azure Cosmos DB database account is deployed.
+| Field | +Description | +
|---|---|
+documentEndpoint+ +string + + |
+
+ DocumentEndpoint: The connection endpoint for the specific region. Example: +https://<accountName>-<locationName>.documents.azure.com:443/ + |
+
+failoverPriority+ +int + + |
+
+ FailoverPriority: The failover priority of the region. A failover priority of 0 indicates a write region. The maximum +value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the +regions in which the database account exists. + |
+
+id+ +string + + |
+
+ Id: The unique identifier of the region within the database account. Example: <accountName>-<locationName>. + |
+
+isZoneRedundant+ +bool + + |
+
+ IsZoneRedundant: Flag to indicate whether or not this region is an AvailabilityZone region + |
+
+locationName+ +string + + |
+
+ LocationName: The name of the region. + |
+
+provisioningState+ +string + + |
++ | +
+(Appears on:DatabaseAccount_Spec) +
+Identity for the resource.
+| Field | +Description | +
|---|---|
+type+ + +ManagedServiceIdentity_Type + + + |
+
+ Type: The type of identity used for the resource. The type ‘SystemAssigned,UserAssigned’ includes both an implicitly +created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the service. + |
+
+userAssignedIdentities+ + +[]UserAssignedIdentityDetails + + + |
+
+ UserAssignedIdentities: The list of user identities associated with resource. The user identity dictionary key +references will be ARM resource ids in the form: +‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’. + |
+
+(Appears on:DatabaseAccount_STATUS) +
+Identity for the resource.
+| Field | +Description | +
|---|---|
+principalId+ +string + + |
+
+ PrincipalId: The principal id of the system assigned identity. This property will only be provided for a system assigned +identity. + |
+
+tenantId+ +string + + |
+
+ TenantId: The tenant id of the system assigned identity. This property will only be provided for a system assigned +identity. + |
+
+type+ + +ManagedServiceIdentity_Type_STATUS + + + |
+
+ Type: The type of identity used for the resource. The type ‘SystemAssigned,UserAssigned’ includes both an implicitly +created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the service. + |
+
+userAssignedIdentities+ + +map[string]./api/documentdb/v1api20240815.ManagedServiceIdentity_UserAssignedIdentities_STATUS + + + |
+
+ UserAssignedIdentities: The list of user identities associated with resource. The user identity dictionary key +references will be ARM resource ids in the form: +‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’. + |
+
string alias)+(Appears on:ManagedServiceIdentity) +
+| Value | +Description | +
|---|---|
"None" |
++ |
"SystemAssigned" |
++ |
"SystemAssigned,UserAssigned" |
++ |
"UserAssigned" |
++ |
string alias)+(Appears on:ManagedServiceIdentity_STATUS) +
+| Value | +Description | +
|---|---|
"None" |
++ |
"SystemAssigned" |
++ |
"SystemAssigned,UserAssigned" |
++ |
"UserAssigned" |
++ |
+(Appears on:ManagedServiceIdentity_STATUS) +
+| Field | +Description | +
|---|---|
+clientId+ +string + + |
+
+ ClientId: The client id of user assigned identity. + |
+
+principalId+ +string + + |
+
+ PrincipalId: The principal id of user assigned identity. + |
+
string alias)+(Appears on:DatabaseAccount_Spec) +
+Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.
+| Value | +Description | +
|---|---|
"Tls" |
++ |
"Tls11" |
++ |
"Tls12" |
++ |
string alias)+(Appears on:DatabaseAccount_STATUS) +
+Indicates the minimum allowed Tls version. The default value is Tls 1.2. Cassandra and Mongo APIs only work with Tls 1.2.
+| Value | +Description | +
|---|---|
"Tls" |
++ |
"Tls11" |
++ |
"Tls12" |
++ |
+(Appears on:MongodbDatabaseCollection_STATUS) +
+| Field | +Description | +
|---|---|
+analyticalStorageTtl+ +int + + |
+
+ AnalyticalStorageTtl: Analytical TTL. + |
+
+createMode+ + +CreateMode_STATUS + + + |
+
+ CreateMode: Enum to indicate the mode of resource creation. + |
+
+_etag+ +string + + |
+
+ Etag: A system generated property representing the resource etag required for optimistic concurrency control. + |
+
+id+ +string + + |
+
+ Id: Name of the Cosmos DB MongoDB collection + |
+
+indexes+ + +[]MongoIndex_STATUS + + + |
+
+ Indexes: List of index keys + |
+
+restoreParameters+ + +RestoreParametersBase_STATUS + + + |
+
+ RestoreParameters: Parameters to indicate the information about the restore + |
+
+_rid+ +string + + |
+
+ Rid: A system generated property. A unique identifier. + |
+
+shardKey+ +map[string]string + + |
+
+ ShardKey: A key-value pair of shard keys to be applied for the request. + |
+
+_ts+ +float64 + + |
+
+ Ts: A system generated property that denotes the last updated timestamp of the resource. + |
+
+(Appears on:MongodbDatabaseCollection_Spec) +
+Cosmos DB MongoDB collection resource object
+| Field | +Description | +
|---|---|
+analyticalStorageTtl+ +int + + |
+
+ AnalyticalStorageTtl: Analytical TTL. + |
+
+createMode+ + +CreateMode + + + |
+
+ CreateMode: Enum to indicate the mode of resource creation. + |
+
+id+ +string + + |
+
+ Id: Name of the Cosmos DB MongoDB collection + |
+
+indexes+ + +[]MongoIndex + + + |
+
+ Indexes: List of index keys + |
+
+restoreParameters+ + +RestoreParametersBase + + + |
+
+ RestoreParameters: Parameters to indicate the information about the restore + |
+
+shardKey+ +map[string]string + + |
+
+ ShardKey: A key-value pair of shard keys to be applied for the request. + |
+
+(Appears on:MongodbDatabase_STATUS) +
+| Field | +Description | +
|---|---|
+createMode+ + +CreateMode_STATUS + + + |
+
+ CreateMode: Enum to indicate the mode of resource creation. + |
+
+_etag+ +string + + |
+
+ Etag: A system generated property representing the resource etag required for optimistic concurrency control. + |
+
+id+ +string + + |
+
+ Id: Name of the Cosmos DB MongoDB database + |
+
+restoreParameters+ + +RestoreParametersBase_STATUS + + + |
+
+ RestoreParameters: Parameters to indicate the information about the restore + |
+
+_rid+ +string + + |
+
+ Rid: A system generated property. A unique identifier. + |
+
+_ts+ +float64 + + |
+
+ Ts: A system generated property that denotes the last updated timestamp of the resource. + |
+
+(Appears on:MongodbDatabase_Spec) +
+Cosmos DB MongoDB database resource object
+| Field | +Description | +
|---|---|
+createMode+ + +CreateMode + + + |
+
+ CreateMode: Enum to indicate the mode of resource creation. + |
+
+id+ +string + + |
+
+ Id: Name of the Cosmos DB MongoDB database + |
+
+restoreParameters+ + +RestoreParametersBase + + + |
+
+ RestoreParameters: Parameters to indicate the information about the restore + |
+
+(Appears on:MongoDBCollectionResource) +
+Cosmos DB MongoDB collection index key
+| Field | +Description | +
|---|---|
+key+ + +MongoIndexKeys + + + |
+
+ Key: Cosmos DB MongoDB collection index keys + |
+
+options+ + +MongoIndexOptions + + + |
+
+ Options: Cosmos DB MongoDB collection index key options + |
+
+(Appears on:MongoIndex) +
+Cosmos DB MongoDB collection resource object
+| Field | +Description | +
|---|---|
+keys+ +[]string + + |
+
+ Keys: List of keys for each MongoDB collection in the Azure Cosmos DB service + |
+
+(Appears on:MongoIndex_STATUS) +
+Cosmos DB MongoDB collection resource object
+| Field | +Description | +
|---|---|
+keys+ +[]string + + |
+
+ Keys: List of keys for each MongoDB collection in the Azure Cosmos DB service + |
+
+(Appears on:MongoIndex) +
+Cosmos DB MongoDB collection index options
+| Field | +Description | +
|---|---|
+expireAfterSeconds+ +int + + |
+
+ ExpireAfterSeconds: Expire after seconds + |
+
+unique+ +bool + + |
+
+ Unique: Is unique or not + |
+
+(Appears on:MongoIndex_STATUS) +
+Cosmos DB MongoDB collection index options
+| Field | +Description | +
|---|---|
+expireAfterSeconds+ +int + + |
+
+ ExpireAfterSeconds: Expire after seconds + |
+
+unique+ +bool + + |
+
+ Unique: Is unique or not + |
+
+(Appears on:MongoDBCollectionGetProperties_Resource_STATUS) +
+Cosmos DB MongoDB collection index key
+| Field | +Description | +
|---|---|
+key+ + +MongoIndexKeys_STATUS + + + |
+
+ Key: Cosmos DB MongoDB collection index keys + |
+
+options+ + +MongoIndexOptions_STATUS + + + |
+
+ Options: Cosmos DB MongoDB collection index key options + |
+
Generator information: +- Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-08-15/cosmos-db.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName} +
| Field | +Description | +||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||
+spec+ + +MongodbDatabase_Spec + + + |
+
+ + +
|
+||||||||||||||
+status+ + +MongodbDatabase_STATUS + + + |
++ | +
Generator information: +- Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-08-15/cosmos-db.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName} +
| Field | +Description | +||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||
+spec+ + +MongodbDatabaseCollection_Spec + + + |
+
+ + +
|
+||||||||||||||
+status+ + +MongodbDatabaseCollection_STATUS + + + |
++ | +
+(Appears on:MongodbDatabaseCollection_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
Generator information: +- Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-08-15/cosmos-db.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default +
| Field | +Description | +||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||
+spec+ + +MongodbDatabaseCollectionThroughputSetting_Spec + + + |
+
+ + +
|
+||||||||||
+status+ + +MongodbDatabaseCollectionThroughputSetting_STATUS + + + |
++ | +
+(Appears on:MongodbDatabaseCollectionThroughputSetting_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:MongodbDatabaseCollectionThroughputSetting) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+id+ +string + + |
+
+ Id: The unique resource identifier of the ARM resource. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+name+ +string + + |
+
+ Name: The name of the ARM resource. + |
+
+resource+ + +ThroughputSettingsGetProperties_Resource_STATUS + + + |
++ | +
+tags+ +map[string]string + + |
++ | +
+type+ +string + + |
+
+ Type: The type of Azure resource. + |
+
+(Appears on:MongodbDatabaseCollectionThroughputSetting) +
+| Field | +Description | +
|---|---|
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+operatorSpec+ + +MongodbDatabaseCollectionThroughputSettingOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a documentdb.azure.com/MongodbDatabaseCollection resource + |
+
+resource+ + +ThroughputSettingsResource + + + |
+
+ Resource: The standard JSON format of a resource throughput + |
+
+tags+ +map[string]string + + |
++ | +
+(Appears on:MongodbDatabaseCollection) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+id+ +string + + |
+
+ Id: The unique resource identifier of the ARM resource. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+name+ +string + + |
+
+ Name: The name of the ARM resource. + |
+
+options+ + +OptionsResource_STATUS + + + |
+
+ Options: Cosmos DB options resource object + |
+
+resource+ + +MongoDBCollectionGetProperties_Resource_STATUS + + + |
++ | +
+tags+ +map[string]string + + |
++ | +
+type+ +string + + |
+
+ Type: The type of Azure resource. + |
+
+(Appears on:MongodbDatabaseCollection) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+operatorSpec+ + +MongodbDatabaseCollectionOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+options+ + +CreateUpdateOptions + + + |
+
+ Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the +request. + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a documentdb.azure.com/MongodbDatabase resource + |
+
+resource+ + +MongoDBCollectionResource + + + |
+
+ Resource: The standard JSON format of a MongoDB collection + |
+
+tags+ +map[string]string + + |
++ | +
+(Appears on:MongodbDatabase_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
Generator information: +- Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-08-15/cosmos-db.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default +
| Field | +Description | +||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||
+spec+ + +MongodbDatabaseThroughputSetting_Spec + + + |
+
+ + +
|
+||||||||||
+status+ + +MongodbDatabaseThroughputSetting_STATUS + + + |
++ | +
+(Appears on:MongodbDatabaseThroughputSetting_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:MongodbDatabaseThroughputSetting) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+id+ +string + + |
+
+ Id: The unique resource identifier of the ARM resource. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+name+ +string + + |
+
+ Name: The name of the ARM resource. + |
+
+resource+ + +ThroughputSettingsGetProperties_Resource_STATUS + + + |
++ | +
+tags+ +map[string]string + + |
++ | +
+type+ +string + + |
+
+ Type: The type of Azure resource. + |
+
+(Appears on:MongodbDatabaseThroughputSetting) +
+| Field | +Description | +
|---|---|
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+operatorSpec+ + +MongodbDatabaseThroughputSettingOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a documentdb.azure.com/MongodbDatabase resource + |
+
+resource+ + +ThroughputSettingsResource + + + |
+
+ Resource: The standard JSON format of a resource throughput + |
+
+tags+ +map[string]string + + |
++ | +
+(Appears on:MongodbDatabase) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+id+ +string + + |
+
+ Id: The unique resource identifier of the ARM resource. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+name+ +string + + |
+
+ Name: The name of the ARM resource. + |
+
+options+ + +OptionsResource_STATUS + + + |
+
+ Options: Cosmos DB options resource object + |
+
+resource+ + +MongoDBDatabaseGetProperties_Resource_STATUS + + + |
++ | +
+tags+ +map[string]string + + |
++ | +
+type+ +string + + |
+
+ Type: The type of Azure resource. + |
+
+(Appears on:MongodbDatabase) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+operatorSpec+ + +MongodbDatabaseOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+options+ + +CreateUpdateOptions + + + |
+
+ Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the +request. + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a documentdb.azure.com/DatabaseAccount resource + |
+
+resource+ + +MongoDBDatabaseResource + + + |
+
+ Resource: The standard JSON format of a MongoDB database + |
+
+tags+ +map[string]string + + |
++ | +
Generator information: +- Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-08-15/mongorbac.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbUserDefinitions/{mongoUserDefinitionId} +
| Field | +Description | +||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||
+spec+ + +MongodbUserDefinition_Spec + + + |
+
+ + +
|
+||||||||||||||||||
+status+ + +MongodbUserDefinition_STATUS + + + |
++ | +
+(Appears on:MongodbUserDefinition_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:MongodbUserDefinition) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+customData+ +string + + |
+
+ CustomData: A custom definition for the USer Definition. + |
+
+databaseName+ +string + + |
+
+ DatabaseName: The database name for which access is being granted for this User Definition. + |
+
+id+ +string + + |
+
+ Id: The unique resource identifier of the database account. + |
+
+mechanisms+ +string + + |
+
+ Mechanisms: The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256. + |
+
+name+ +string + + |
+
+ Name: The name of the database account. + |
+
+roles+ + +[]Role_STATUS + + + |
+
+ Roles: The set of roles inherited by the User Definition. + |
+
+type+ +string + + |
+
+ Type: The type of Azure resource. + |
+
+userName+ +string + + |
+
+ UserName: The user name for User Definition. + |
+
+(Appears on:MongodbUserDefinition) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+customData+ +string + + |
+
+ CustomData: A custom definition for the USer Definition. + |
+
+databaseName+ +string + + |
+
+ DatabaseName: The database name for which access is being granted for this User Definition. + |
+
+mechanisms+ +string + + |
+
+ Mechanisms: The Mongo Auth mechanism. For now, we only support auth mechanism SCRAM-SHA-256. + |
+
+operatorSpec+ + +MongodbUserDefinitionOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a documentdb.azure.com/DatabaseAccount resource + |
+
+password+ + +genruntime.SecretReference + + + |
+
+ Password: The password for User Definition. Response does not contain user password. + |
+
+roles+ + +[]Role + + + |
+
+ Roles: The set of roles inherited by the User Definition. + |
+
+userName+ +string + + |
+
+ UserName: The user name for User Definition. + |
+
string alias)+(Appears on:DatabaseAccount_Spec) +
+Indicates what services are allowed to bypass firewall checks.
+| Value | +Description | +
|---|---|
"AzureServices" |
++ |
"None" |
++ |
string alias)+(Appears on:DatabaseAccount_STATUS) +
+Indicates what services are allowed to bypass firewall checks.
+| Value | +Description | +
|---|---|
"AzureServices" |
++ |
"None" |
++ |
+(Appears on:MongodbDatabaseCollection_STATUS, MongodbDatabase_STATUS, SqlDatabaseContainer_STATUS, SqlDatabase_STATUS) +
+Cosmos DB options resource object
+| Field | +Description | +
|---|---|
+autoscaleSettings+ + +AutoscaleSettings_STATUS + + + |
+
+ AutoscaleSettings: Specifies the Autoscale settings. + |
+
+throughput+ +int + + |
+
+ Throughput: Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when +retrieving offer details. + |
+
+(Appears on:BackupPolicy) +
+| Field | +Description | +
|---|---|
+migrationState+ + +BackupPolicyMigrationState + + + |
+
+ MigrationState: The object representing the state of the migration between the backup policies. + |
+
+periodicModeProperties+ + +PeriodicModeProperties + + + |
+
+ PeriodicModeProperties: Configuration values for periodic mode backup + |
+
+type+ + +PeriodicModeBackupPolicy_Type + + + |
+
+ Type: Describes the mode of backups. + |
+
+(Appears on:BackupPolicy_STATUS) +
+| Field | +Description | +
|---|---|
+migrationState+ + +BackupPolicyMigrationState_STATUS + + + |
+
+ MigrationState: The object representing the state of the migration between the backup policies. + |
+
+periodicModeProperties+ + +PeriodicModeProperties_STATUS + + + |
+
+ PeriodicModeProperties: Configuration values for periodic mode backup + |
+
+type+ + +PeriodicModeBackupPolicy_Type_STATUS + + + |
+
+ Type: Describes the mode of backups. + |
+
string alias)+(Appears on:PeriodicModeBackupPolicy) +
+| Value | +Description | +
|---|---|
"Periodic" |
++ |
string alias)+(Appears on:PeriodicModeBackupPolicy_STATUS) +
+| Value | +Description | +
|---|---|
"Periodic" |
++ |
+(Appears on:PeriodicModeBackupPolicy) +
+Configuration values for periodic mode backup
+| Field | +Description | +
|---|---|
+backupIntervalInMinutes+ +int + + |
+
+ BackupIntervalInMinutes: An integer representing the interval in minutes between two backups + |
+
+backupRetentionIntervalInHours+ +int + + |
+
+ BackupRetentionIntervalInHours: An integer representing the time (in hours) that each backup is retained + |
+
+backupStorageRedundancy+ + +BackupStorageRedundancy + + + |
+
+ BackupStorageRedundancy: Enum to indicate type of backup residency + |
+
+(Appears on:PeriodicModeBackupPolicy_STATUS) +
+Configuration values for periodic mode backup
+| Field | +Description | +
|---|---|
+backupIntervalInMinutes+ +int + + |
+
+ BackupIntervalInMinutes: An integer representing the interval in minutes between two backups + |
+
+backupRetentionIntervalInHours+ +int + + |
+
+ BackupRetentionIntervalInHours: An integer representing the time (in hours) that each backup is retained + |
+
+backupStorageRedundancy+ + +BackupStorageRedundancy_STATUS + + + |
+
+ BackupStorageRedundancy: Enum to indicate type of backup residency + |
+
+(Appears on:DatabaseAccount_STATUS) +
+A private endpoint connection
+| Field | +Description | +
|---|---|
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} + |
+
string alias)+(Appears on:DatabaseAccount_Spec) +
+Whether requests from Public Network are allowed
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
"SecuredByPerimeter" |
++ |
string alias)+(Appears on:DatabaseAccount_STATUS) +
+Whether requests from Public Network are allowed
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
"SecuredByPerimeter" |
++ |
+(Appears on:DatabaseAccount_Spec) +
+Parameters to indicate the information about the restore.
+| Field | +Description | +
|---|---|
+databasesToRestore+ + +[]DatabaseRestoreResource + + + |
+
+ DatabasesToRestore: List of specific databases available for restore. + |
+
+gremlinDatabasesToRestore+ + +[]GremlinDatabaseRestoreResource + + + |
+
+ GremlinDatabasesToRestore: List of specific gremlin databases available for restore. + |
+
+restoreMode+ + +RestoreParameters_RestoreMode + + + |
+
+ RestoreMode: Describes the mode of the restore. + |
+
+restoreSource+ +string + + |
+
+ RestoreSource: The id of the restorable database account from which the restore has to be initiated. For example: +/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} + |
+
+restoreTimestampInUtc+ +string + + |
+
+ RestoreTimestampInUtc: Time to which the account has to be restored (ISO-8601 format). + |
+
+restoreWithTtlDisabled+ +bool + + |
+
+ RestoreWithTtlDisabled: Specifies whether the restored account will have Time-To-Live disabled upon the successful +restore. + |
+
+tablesToRestore+ +[]string + + |
+
+ TablesToRestore: List of specific tables available for restore. + |
+
+(Appears on:MongoDBCollectionResource, MongoDBDatabaseResource, SqlContainerResource, SqlDatabaseResource) +
+Parameters to indicate the information about the restore.
+| Field | +Description | +
|---|---|
+restoreSource+ +string + + |
+
+ RestoreSource: The id of the restorable database account from which the restore has to be initiated. For example: +/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} + |
+
+restoreTimestampInUtc+ +string + + |
+
+ RestoreTimestampInUtc: Time to which the account has to be restored (ISO-8601 format). + |
+
+restoreWithTtlDisabled+ +bool + + |
+
+ RestoreWithTtlDisabled: Specifies whether the restored account will have Time-To-Live disabled upon the successful +restore. + |
+
+(Appears on:MongoDBCollectionGetProperties_Resource_STATUS, MongoDBDatabaseGetProperties_Resource_STATUS, SqlContainerGetProperties_Resource_STATUS, SqlDatabaseGetProperties_Resource_STATUS) +
+Parameters to indicate the information about the restore.
+| Field | +Description | +
|---|---|
+restoreSource+ +string + + |
+
+ RestoreSource: The id of the restorable database account from which the restore has to be initiated. For example: +/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} + |
+
+restoreTimestampInUtc+ +string + + |
+
+ RestoreTimestampInUtc: Time to which the account has to be restored (ISO-8601 format). + |
+
+restoreWithTtlDisabled+ +bool + + |
+
+ RestoreWithTtlDisabled: Specifies whether the restored account will have Time-To-Live disabled upon the successful +restore. + |
+
string alias)+(Appears on:RestoreParameters) +
+| Value | +Description | +
|---|---|
"PointInTime" |
++ |
string alias)+(Appears on:RestoreParameters_STATUS) +
+| Value | +Description | +
|---|---|
"PointInTime" |
++ |
+(Appears on:DatabaseAccount_STATUS) +
+Parameters to indicate the information about the restore.
+| Field | +Description | +
|---|---|
+databasesToRestore+ + +[]DatabaseRestoreResource_STATUS + + + |
+
+ DatabasesToRestore: List of specific databases available for restore. + |
+
+gremlinDatabasesToRestore+ + +[]GremlinDatabaseRestoreResource_STATUS + + + |
+
+ GremlinDatabasesToRestore: List of specific gremlin databases available for restore. + |
+
+restoreMode+ + +RestoreParameters_RestoreMode_STATUS + + + |
+
+ RestoreMode: Describes the mode of the restore. + |
+
+restoreSource+ +string + + |
+
+ RestoreSource: The id of the restorable database account from which the restore has to be initiated. For example: +/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{restorableDatabaseAccountName} + |
+
+restoreTimestampInUtc+ +string + + |
+
+ RestoreTimestampInUtc: Time to which the account has to be restored (ISO-8601 format). + |
+
+restoreWithTtlDisabled+ +bool + + |
+
+ RestoreWithTtlDisabled: Specifies whether the restored account will have Time-To-Live disabled upon the successful +restore. + |
+
+tablesToRestore+ +[]string + + |
+
+ TablesToRestore: List of specific tables available for restore. + |
+
+(Appears on:MongodbUserDefinition_Spec) +
+The set of roles permitted through this Role Definition.
+| Field | +Description | +
|---|---|
+db+ +string + + |
+
+ Db: The database name the role is applied. + |
+
+role+ +string + + |
+
+ Role: The role name. + |
+
+(Appears on:MongodbUserDefinition_STATUS) +
+The set of roles permitted through this Role Definition.
+| Field | +Description | +
|---|---|
+db+ +string + + |
+
+ Db: The database name the role is applied. + |
+
+role+ +string + + |
+
+ Role: The role name. + |
+
+(Appears on:IndexingPolicy) +
+| Field | +Description | +
|---|---|
+path+ +string + + |
+
+ Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard +(/path/*) + |
+
+types+ + +[]SpatialType + + + |
+
+ Types: List of path’s spatial type + |
+
+(Appears on:IndexingPolicy_STATUS) +
+| Field | +Description | +
|---|---|
+path+ +string + + |
+
+ Path: The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard +(/path/*) + |
+
+types+ + +[]SpatialType_STATUS + + + |
+
+ Types: List of path’s spatial type + |
+
string alias)+(Appears on:SpatialSpec) +
+Indicates the spatial type of index.
+| Value | +Description | +
|---|---|
"LineString" |
++ |
"MultiPolygon" |
++ |
"Point" |
++ |
"Polygon" |
++ |
string alias)+(Appears on:SpatialSpec_STATUS) +
+Indicates the spatial type of index.
+| Value | +Description | +
|---|---|
"LineString" |
++ |
"MultiPolygon" |
++ |
"Point" |
++ |
"Polygon" |
++ |
+(Appears on:SqlDatabaseContainer_STATUS) +
+| Field | +Description | +
|---|---|
+analyticalStorageTtl+ +int + + |
+
+ AnalyticalStorageTtl: Analytical TTL. + |
+
+clientEncryptionPolicy+ + +ClientEncryptionPolicy_STATUS + + + |
+
+ ClientEncryptionPolicy: The client encryption policy for the container. + |
+
+computedProperties+ + +[]ComputedProperty_STATUS + + + |
+
+ ComputedProperties: List of computed properties + |
+
+conflictResolutionPolicy+ + +ConflictResolutionPolicy_STATUS + + + |
+
+ ConflictResolutionPolicy: The conflict resolution policy for the container. + |
+
+createMode+ + +CreateMode_STATUS + + + |
+
+ CreateMode: Enum to indicate the mode of resource creation. + |
+
+defaultTtl+ +int + + |
+
+ DefaultTtl: Default time to live + |
+
+_etag+ +string + + |
+
+ Etag: A system generated property representing the resource etag required for optimistic concurrency control. + |
+
+id+ +string + + |
+
+ Id: Name of the Cosmos DB SQL container + |
+
+indexingPolicy+ + +IndexingPolicy_STATUS + + + |
+
+ IndexingPolicy: The configuration of the indexing policy. By default, the indexing is automatic for all document paths +within the container + |
+
+partitionKey+ + +ContainerPartitionKey_STATUS + + + |
+
+ PartitionKey: The configuration of the partition key to be used for partitioning data into multiple partitions + |
+
+restoreParameters+ + +RestoreParametersBase_STATUS + + + |
+
+ RestoreParameters: Parameters to indicate the information about the restore + |
+
+_rid+ +string + + |
+
+ Rid: A system generated property. A unique identifier. + |
+
+_ts+ +float64 + + |
+
+ Ts: A system generated property that denotes the last updated timestamp of the resource. + |
+
+uniqueKeyPolicy+ + +UniqueKeyPolicy_STATUS + + + |
+
+ UniqueKeyPolicy: The unique key policy configuration for specifying uniqueness constraints on documents in the +collection in the Azure Cosmos DB service. + |
+
+(Appears on:SqlDatabaseContainer_Spec) +
+Cosmos DB SQL container resource object
+| Field | +Description | +
|---|---|
+analyticalStorageTtl+ +int + + |
+
+ AnalyticalStorageTtl: Analytical TTL. + |
+
+clientEncryptionPolicy+ + +ClientEncryptionPolicy + + + |
+
+ ClientEncryptionPolicy: The client encryption policy for the container. + |
+
+computedProperties+ + +[]ComputedProperty + + + |
+
+ ComputedProperties: List of computed properties + |
+
+conflictResolutionPolicy+ + +ConflictResolutionPolicy + + + |
+
+ ConflictResolutionPolicy: The conflict resolution policy for the container. + |
+
+createMode+ + +CreateMode + + + |
+
+ CreateMode: Enum to indicate the mode of resource creation. + |
+
+defaultTtl+ +int + + |
+
+ DefaultTtl: Default time to live + |
+
+id+ +string + + |
+
+ Id: Name of the Cosmos DB SQL container + |
+
+indexingPolicy+ + +IndexingPolicy + + + |
+
+ IndexingPolicy: The configuration of the indexing policy. By default, the indexing is automatic for all document paths +within the container + |
+
+partitionKey+ + +ContainerPartitionKey + + + |
+
+ PartitionKey: The configuration of the partition key to be used for partitioning data into multiple partitions + |
+
+restoreParameters+ + +RestoreParametersBase + + + |
+
+ RestoreParameters: Parameters to indicate the information about the restore + |
+
+uniqueKeyPolicy+ + +UniqueKeyPolicy + + + |
+
+ UniqueKeyPolicy: The unique key policy configuration for specifying uniqueness constraints on documents in the +collection in the Azure Cosmos DB service. + |
+
Generator information: +- Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-08-15/cosmos-db.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName} +
| Field | +Description | +||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||
+spec+ + +SqlDatabase_Spec + + + |
+
+ + +
|
+||||||||||||||
+status+ + +SqlDatabase_STATUS + + + |
++ | +
Generator information: +- Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-08-15/cosmos-db.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName} +
| Field | +Description | +||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||
+spec+ + +SqlDatabaseContainer_Spec + + + |
+
+ + +
|
+||||||||||||||
+status+ + +SqlDatabaseContainer_STATUS + + + |
++ | +
+(Appears on:SqlDatabaseContainer_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
Generator information: +- Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-08-15/cosmos-db.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName} +
| Field | +Description | +||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||
+spec+ + +SqlDatabaseContainerStoredProcedure_Spec + + + |
+
+ + +
|
+||||||||||||||
+status+ + +SqlDatabaseContainerStoredProcedure_STATUS + + + |
++ | +
+(Appears on:SqlDatabaseContainerStoredProcedure_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:SqlDatabaseContainerStoredProcedure) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+id+ +string + + |
+
+ Id: The unique resource identifier of the ARM resource. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+name+ +string + + |
+
+ Name: The name of the ARM resource. + |
+
+resource+ + +SqlStoredProcedureGetProperties_Resource_STATUS + + + |
++ | +
+tags+ +map[string]string + + |
++ | +
+type+ +string + + |
+
+ Type: The type of Azure resource. + |
+
+(Appears on:SqlDatabaseContainerStoredProcedure) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+operatorSpec+ + +SqlDatabaseContainerStoredProcedureOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+options+ + +CreateUpdateOptions + + + |
+
+ Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the +request. + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a documentdb.azure.com/SqlDatabaseContainer resource + |
+
+resource+ + +SqlStoredProcedureResource + + + |
+
+ Resource: The standard JSON format of a storedProcedure + |
+
+tags+ +map[string]string + + |
++ | +
Generator information: +- Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-08-15/cosmos-db.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default +
| Field | +Description | +||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||
+spec+ + +SqlDatabaseContainerThroughputSetting_Spec + + + |
+
+ + +
|
+||||||||||
+status+ + +SqlDatabaseContainerThroughputSetting_STATUS + + + |
++ | +
+(Appears on:SqlDatabaseContainerThroughputSetting_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:SqlDatabaseContainerThroughputSetting) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+id+ +string + + |
+
+ Id: The unique resource identifier of the ARM resource. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+name+ +string + + |
+
+ Name: The name of the ARM resource. + |
+
+resource+ + +ThroughputSettingsGetProperties_Resource_STATUS + + + |
++ | +
+tags+ +map[string]string + + |
++ | +
+type+ +string + + |
+
+ Type: The type of Azure resource. + |
+
+(Appears on:SqlDatabaseContainerThroughputSetting) +
+| Field | +Description | +
|---|---|
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+operatorSpec+ + +SqlDatabaseContainerThroughputSettingOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a documentdb.azure.com/SqlDatabaseContainer resource + |
+
+resource+ + +ThroughputSettingsResource + + + |
+
+ Resource: The standard JSON format of a resource throughput + |
+
+tags+ +map[string]string + + |
++ | +
Generator information: +- Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-08-15/cosmos-db.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers/{triggerName} +
| Field | +Description | +||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||
+spec+ + +SqlDatabaseContainerTrigger_Spec + + + |
+
+ + +
|
+||||||||||||||
+status+ + +SqlDatabaseContainerTrigger_STATUS + + + |
++ | +
+(Appears on:SqlDatabaseContainerTrigger_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:SqlDatabaseContainerTrigger) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+id+ +string + + |
+
+ Id: The unique resource identifier of the ARM resource. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+name+ +string + + |
+
+ Name: The name of the ARM resource. + |
+
+resource+ + +SqlTriggerGetProperties_Resource_STATUS + + + |
++ | +
+tags+ +map[string]string + + |
++ | +
+type+ +string + + |
+
+ Type: The type of Azure resource. + |
+
+(Appears on:SqlDatabaseContainerTrigger) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+operatorSpec+ + +SqlDatabaseContainerTriggerOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+options+ + +CreateUpdateOptions + + + |
+
+ Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the +request. + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a documentdb.azure.com/SqlDatabaseContainer resource + |
+
+resource+ + +SqlTriggerResource + + + |
+
+ Resource: The standard JSON format of a trigger + |
+
+tags+ +map[string]string + + |
++ | +
Generator information: +- Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-08-15/cosmos-db.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName} +
| Field | +Description | +||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||
+spec+ + +SqlDatabaseContainerUserDefinedFunction_Spec + + + |
+
+ + +
|
+||||||||||||||
+status+ + +SqlDatabaseContainerUserDefinedFunction_STATUS + + + |
++ | +
+(Appears on:SqlDatabaseContainerUserDefinedFunction_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:SqlDatabaseContainerUserDefinedFunction) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+id+ +string + + |
+
+ Id: The unique resource identifier of the ARM resource. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+name+ +string + + |
+
+ Name: The name of the ARM resource. + |
+
+resource+ + +SqlUserDefinedFunctionGetProperties_Resource_STATUS + + + |
++ | +
+tags+ +map[string]string + + |
++ | +
+type+ +string + + |
+
+ Type: The type of Azure resource. + |
+
+(Appears on:SqlDatabaseContainerUserDefinedFunction) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+operatorSpec+ + +SqlDatabaseContainerUserDefinedFunctionOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+options+ + +CreateUpdateOptions + + + |
+
+ Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the +request. + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a documentdb.azure.com/SqlDatabaseContainer resource + |
+
+resource+ + +SqlUserDefinedFunctionResource + + + |
+
+ Resource: The standard JSON format of a userDefinedFunction + |
+
+tags+ +map[string]string + + |
++ | +
+(Appears on:SqlDatabaseContainer) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+id+ +string + + |
+
+ Id: The unique resource identifier of the ARM resource. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+name+ +string + + |
+
+ Name: The name of the ARM resource. + |
+
+options+ + +OptionsResource_STATUS + + + |
+
+ Options: Cosmos DB options resource object + |
+
+resource+ + +SqlContainerGetProperties_Resource_STATUS + + + |
++ | +
+tags+ +map[string]string + + |
++ | +
+type+ +string + + |
+
+ Type: The type of Azure resource. + |
+
+(Appears on:SqlDatabaseContainer) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+operatorSpec+ + +SqlDatabaseContainerOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+options+ + +CreateUpdateOptions + + + |
+
+ Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the +request. + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a documentdb.azure.com/SqlDatabase resource + |
+
+resource+ + +SqlContainerResource + + + |
+
+ Resource: The standard JSON format of a container + |
+
+tags+ +map[string]string + + |
++ | +
+(Appears on:SqlDatabase_STATUS) +
+| Field | +Description | +
|---|---|
+_colls+ +string + + |
+
+ Colls: A system generated property that specified the addressable path of the collections resource. + |
+
+createMode+ + +CreateMode_STATUS + + + |
+
+ CreateMode: Enum to indicate the mode of resource creation. + |
+
+_etag+ +string + + |
+
+ Etag: A system generated property representing the resource etag required for optimistic concurrency control. + |
+
+id+ +string + + |
+
+ Id: Name of the Cosmos DB SQL database + |
+
+restoreParameters+ + +RestoreParametersBase_STATUS + + + |
+
+ RestoreParameters: Parameters to indicate the information about the restore + |
+
+_rid+ +string + + |
+
+ Rid: A system generated property. A unique identifier. + |
+
+_ts+ +float64 + + |
+
+ Ts: A system generated property that denotes the last updated timestamp of the resource. + |
+
+_users+ +string + + |
+
+ Users: A system generated property that specifies the addressable path of the users resource. + |
+
+(Appears on:SqlDatabase_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:SqlDatabase_Spec) +
+Cosmos DB SQL database resource object
+| Field | +Description | +
|---|---|
+createMode+ + +CreateMode + + + |
+
+ CreateMode: Enum to indicate the mode of resource creation. + |
+
+id+ +string + + |
+
+ Id: Name of the Cosmos DB SQL database + |
+
+restoreParameters+ + +RestoreParametersBase + + + |
+
+ RestoreParameters: Parameters to indicate the information about the restore + |
+
Generator information: +- Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-08-15/cosmos-db.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default +
| Field | +Description | +||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||
+spec+ + +SqlDatabaseThroughputSetting_Spec + + + |
+
+ + +
|
+||||||||||
+status+ + +SqlDatabaseThroughputSetting_STATUS + + + |
++ | +
+(Appears on:SqlDatabaseThroughputSetting_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:SqlDatabaseThroughputSetting) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+id+ +string + + |
+
+ Id: The unique resource identifier of the ARM resource. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+name+ +string + + |
+
+ Name: The name of the ARM resource. + |
+
+resource+ + +ThroughputSettingsGetProperties_Resource_STATUS + + + |
++ | +
+tags+ +map[string]string + + |
++ | +
+type+ +string + + |
+
+ Type: The type of Azure resource. + |
+
+(Appears on:SqlDatabaseThroughputSetting) +
+| Field | +Description | +
|---|---|
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+operatorSpec+ + +SqlDatabaseThroughputSettingOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a documentdb.azure.com/SqlDatabase resource + |
+
+resource+ + +ThroughputSettingsResource + + + |
+
+ Resource: The standard JSON format of a resource throughput + |
+
+tags+ +map[string]string + + |
++ | +
+(Appears on:SqlDatabase) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+id+ +string + + |
+
+ Id: The unique resource identifier of the ARM resource. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+name+ +string + + |
+
+ Name: The name of the ARM resource. + |
+
+options+ + +OptionsResource_STATUS + + + |
+
+ Options: Cosmos DB options resource object + |
+
+resource+ + +SqlDatabaseGetProperties_Resource_STATUS + + + |
++ | +
+tags+ +map[string]string + + |
++ | +
+type+ +string + + |
+
+ Type: The type of Azure resource. + |
+
+(Appears on:SqlDatabase) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+location+ +string + + |
+
+ Location: The location of the resource group to which the resource belongs. + |
+
+operatorSpec+ + +SqlDatabaseOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+options+ + +CreateUpdateOptions + + + |
+
+ Options: A key-value pair of options to be applied for the request. This corresponds to the headers sent with the +request. + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a documentdb.azure.com/DatabaseAccount resource + |
+
+resource+ + +SqlDatabaseResource + + + |
+
+ Resource: The standard JSON format of a SQL database + |
+
+tags+ +map[string]string + + |
++ | +
Generator information: +- Generated from: /cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2024-08-15/rbac.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleAssignments/{roleAssignmentId} +
| Field | +Description | +||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||
+spec+ + +SqlRoleAssignment_Spec + + + |
+
+ + +
|
+||||||||||||||
+status+ + +SqlRoleAssignment_STATUS + + + |
++ | +
+(Appears on:SqlRoleAssignment_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:SqlRoleAssignment) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+id+ +string + + |
+
+ Id: The unique resource identifier of the database account. + |
+
+name+ +string + + |
+
+ Name: The name of the database account. + |
+
+principalId+ +string + + |
+
+ PrincipalId: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted +through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. + |
+
+roleDefinitionId+ +string + + |
+
+ RoleDefinitionId: The unique identifier for the associated Role Definition. + |
+
+scope+ +string + + |
+
+ Scope: The data plane resource path for which access is being granted through this Role Assignment. + |
+
+type+ +string + + |
+
+ Type: The type of Azure resource. + |
+
+(Appears on:SqlRoleAssignment) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+operatorSpec+ + +SqlRoleAssignmentOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a documentdb.azure.com/DatabaseAccount resource + |
+
+principalId+ +string + + |
+
+ PrincipalId: The unique identifier for the associated AAD principal in the AAD graph to which access is being granted +through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the subscription. + |
+
+principalIdFromConfig+ + +genruntime.ConfigMapReference + + + |
+
+ PrincipalIdFromConfig: The unique identifier for the associated AAD principal in the AAD graph to which access is being +granted through this Role Assignment. Tenant ID for the principal is inferred using the tenant associated with the +subscription. + |
+
+roleDefinitionId+ +string + + |
+
+ RoleDefinitionId: The unique identifier for the associated Role Definition. + |
+
+scope+ +string + + |
+
+ Scope: The data plane resource path for which access is being granted through this Role Assignment. + |
+
+(Appears on:SqlDatabaseContainerStoredProcedure_STATUS) +
+| Field | +Description | +
|---|---|
+body+ +string + + |
+
+ Body: Body of the Stored Procedure + |
+
+_etag+ +string + + |
+
+ Etag: A system generated property representing the resource etag required for optimistic concurrency control. + |
+
+id+ +string + + |
+
+ Id: Name of the Cosmos DB SQL storedProcedure + |
+
+_rid+ +string + + |
+
+ Rid: A system generated property. A unique identifier. + |
+
+_ts+ +float64 + + |
+
+ Ts: A system generated property that denotes the last updated timestamp of the resource. + |
+
+(Appears on:SqlDatabaseContainerStoredProcedure_Spec) +
+Cosmos DB SQL storedProcedure resource object
+| Field | +Description | +
|---|---|
+body+ +string + + |
+
+ Body: Body of the Stored Procedure + |
+
+id+ +string + + |
+
+ Id: Name of the Cosmos DB SQL storedProcedure + |
+
+(Appears on:SqlDatabaseContainerTrigger_STATUS) +
+| Field | +Description | +
|---|---|
+body+ +string + + |
+
+ Body: Body of the Trigger + |
+
+_etag+ +string + + |
+
+ Etag: A system generated property representing the resource etag required for optimistic concurrency control. + |
+
+id+ +string + + |
+
+ Id: Name of the Cosmos DB SQL trigger + |
+
+_rid+ +string + + |
+
+ Rid: A system generated property. A unique identifier. + |
+
+triggerOperation+ + +SqlTriggerGetProperties_Resource_TriggerOperation_STATUS + + + |
+
+ TriggerOperation: The operation the trigger is associated with + |
+
+triggerType+ + +SqlTriggerGetProperties_Resource_TriggerType_STATUS + + + |
+
+ TriggerType: Type of the Trigger + |
+
+_ts+ +float64 + + |
+
+ Ts: A system generated property that denotes the last updated timestamp of the resource. + |
+
string alias)+(Appears on:SqlTriggerGetProperties_Resource_STATUS) +
+| Value | +Description | +
|---|---|
"All" |
++ |
"Create" |
++ |
"Delete" |
++ |
"Replace" |
++ |
"Update" |
++ |
string alias)+(Appears on:SqlTriggerGetProperties_Resource_STATUS) +
+| Value | +Description | +
|---|---|
"Post" |
++ |
"Pre" |
++ |
+(Appears on:SqlDatabaseContainerTrigger_Spec) +
+Cosmos DB SQL trigger resource object
+| Field | +Description | +
|---|---|
+body+ +string + + |
+
+ Body: Body of the Trigger + |
+
+id+ +string + + |
+
+ Id: Name of the Cosmos DB SQL trigger + |
+
+triggerOperation+ + +SqlTriggerResource_TriggerOperation + + + |
+
+ TriggerOperation: The operation the trigger is associated with + |
+
+triggerType+ + +SqlTriggerResource_TriggerType + + + |
+
+ TriggerType: Type of the Trigger + |
+
string alias)+(Appears on:SqlTriggerResource) +
+| Value | +Description | +
|---|---|
"All" |
++ |
"Create" |
++ |
"Delete" |
++ |
"Replace" |
++ |
"Update" |
++ |
string alias)+(Appears on:SqlTriggerResource) +
+| Value | +Description | +
|---|---|
"Post" |
++ |
"Pre" |
++ |
+(Appears on:SqlDatabaseContainerUserDefinedFunction_STATUS) +
+| Field | +Description | +
|---|---|
+body+ +string + + |
+
+ Body: Body of the User Defined Function + |
+
+_etag+ +string + + |
+
+ Etag: A system generated property representing the resource etag required for optimistic concurrency control. + |
+
+id+ +string + + |
+
+ Id: Name of the Cosmos DB SQL userDefinedFunction + |
+
+_rid+ +string + + |
+
+ Rid: A system generated property. A unique identifier. + |
+
+_ts+ +float64 + + |
+
+ Ts: A system generated property that denotes the last updated timestamp of the resource. + |
+
+(Appears on:SqlDatabaseContainerUserDefinedFunction_Spec) +
+Cosmos DB SQL userDefinedFunction resource object
+| Field | +Description | +
|---|---|
+body+ +string + + |
+
+ Body: Body of the User Defined Function + |
+
+id+ +string + + |
+
+ Id: Name of the Cosmos DB SQL userDefinedFunction + |
+
string alias)+(Appears on:SystemData_STATUS) +
+| Value | +Description | +
|---|---|
"Application" |
++ |
"Key" |
++ |
"ManagedIdentity" |
++ |
"User" |
++ |
string alias)+(Appears on:SystemData_STATUS) +
+| Value | +Description | +
|---|---|
"Application" |
++ |
"Key" |
++ |
"ManagedIdentity" |
++ |
"User" |
++ |
+(Appears on:DatabaseAccount_STATUS) +
+Metadata pertaining to creation and last modification of the resource.
+| Field | +Description | +
|---|---|
+createdAt+ +string + + |
+
+ CreatedAt: The timestamp of resource creation (UTC). + |
+
+createdBy+ +string + + |
+
+ CreatedBy: The identity that created the resource. + |
+
+createdByType+ + +SystemData_CreatedByType_STATUS + + + |
+
+ CreatedByType: The type of identity that created the resource. + |
+
+lastModifiedAt+ +string + + |
+
+ LastModifiedAt: The timestamp of resource last modification (UTC) + |
+
+lastModifiedBy+ +string + + |
+
+ LastModifiedBy: The identity that last modified the resource. + |
+
+lastModifiedByType+ + +SystemData_LastModifiedByType_STATUS + + + |
+
+ LastModifiedByType: The type of identity that last modified the resource. + |
+
+(Appears on:AutoUpgradePolicyResource) +
+Cosmos DB resource throughput policy
+| Field | +Description | +
|---|---|
+incrementPercent+ +int + + |
+
+ IncrementPercent: Represents the percentage by which throughput can increase every time throughput policy kicks in. + |
+
+isEnabled+ +bool + + |
+
+ IsEnabled: Determines whether the ThroughputPolicy is active or not + |
+
+(Appears on:AutoUpgradePolicyResource_STATUS) +
+Cosmos DB resource throughput policy
+| Field | +Description | +
|---|---|
+incrementPercent+ +int + + |
+
+ IncrementPercent: Represents the percentage by which throughput can increase every time throughput policy kicks in. + |
+
+isEnabled+ +bool + + |
+
+ IsEnabled: Determines whether the ThroughputPolicy is active or not + |
+
+(Appears on:MongodbDatabaseCollectionThroughputSetting_STATUS, MongodbDatabaseThroughputSetting_STATUS, SqlDatabaseContainerThroughputSetting_STATUS, SqlDatabaseThroughputSetting_STATUS) +
+| Field | +Description | +
|---|---|
+autoscaleSettings+ + +AutoscaleSettingsResource_STATUS + + + |
+
+ AutoscaleSettings: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is +required, but not both. + |
+
+_etag+ +string + + |
+
+ Etag: A system generated property representing the resource etag required for optimistic concurrency control. + |
+
+instantMaximumThroughput+ +string + + |
+
+ InstantMaximumThroughput: The offer throughput value to instantly scale up without triggering splits + |
+
+minimumThroughput+ +string + + |
+
+ MinimumThroughput: The minimum throughput of the resource + |
+
+offerReplacePending+ +string + + |
+
+ OfferReplacePending: The throughput replace is pending + |
+
+_rid+ +string + + |
+
+ Rid: A system generated property. A unique identifier. + |
+
+softAllowedMaximumThroughput+ +string + + |
+
+ SoftAllowedMaximumThroughput: The maximum throughput value or the maximum maxThroughput value (for autoscale) that can +be specified + |
+
+throughput+ +int + + |
+
+ Throughput: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, +but not both. + |
+
+_ts+ +float64 + + |
+
+ Ts: A system generated property that denotes the last updated timestamp of the resource. + |
+
+(Appears on:MongodbDatabaseCollectionThroughputSetting_Spec, MongodbDatabaseThroughputSetting_Spec, SqlDatabaseContainerThroughputSetting_Spec, SqlDatabaseThroughputSetting_Spec) +
+Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.
+| Field | +Description | +
|---|---|
+autoscaleSettings+ + +AutoscaleSettingsResource + + + |
+
+ AutoscaleSettings: Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is +required, but not both. + |
+
+throughput+ +int + + |
+
+ Throughput: Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, +but not both. + |
+
+(Appears on:UniqueKeyPolicy) +
+The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
+| Field | +Description | +
|---|---|
+paths+ +[]string + + |
+
+ Paths: List of paths must be unique for each document in the Azure Cosmos DB service + |
+
+(Appears on:SqlContainerResource) +
+The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure +Cosmos DB service.
+| Field | +Description | +
|---|---|
+uniqueKeys+ + +[]UniqueKey + + + |
+
+ UniqueKeys: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure +Cosmos DB service. + |
+
+(Appears on:SqlContainerGetProperties_Resource_STATUS) +
+The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure +Cosmos DB service.
+| Field | +Description | +
|---|---|
+uniqueKeys+ + +[]UniqueKey_STATUS + + + |
+
+ UniqueKeys: List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure +Cosmos DB service. + |
+
+(Appears on:UniqueKeyPolicy_STATUS) +
+The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.
+| Field | +Description | +
|---|---|
+paths+ +[]string + + |
+
+ Paths: List of paths must be unique for each document in the Azure Cosmos DB service + |
+
+(Appears on:ManagedServiceIdentity) +
+Information about the user assigned identity for the resource
+| Field | +Description | +
|---|---|
+reference+ + +genruntime.ResourceReference + + + |
++ | +
+(Appears on:DatabaseAccount_Spec) +
+Virtual Network ACL Rule object
+| Field | +Description | +
|---|---|
+ignoreMissingVNetServiceEndpoint+ +bool + + |
+
+ IgnoreMissingVNetServiceEndpoint: Create firewall rule before the virtual network has vnet service endpoint enabled. + |
+
+reference+ + +genruntime.ResourceReference + + + |
+
+ Reference: Resource ID of a subnet, for example: +/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. + |
+
+(Appears on:DatabaseAccount_STATUS) +
+Virtual Network ACL Rule object
+| Field | +Description | +
|---|---|
+id+ +string + + |
+
+ Id: Resource ID of a subnet, for example: +/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}. + |
+
+ignoreMissingVNetServiceEndpoint+ +bool + + |
+
+ IgnoreMissingVNetServiceEndpoint: Create firewall rule before the virtual network has vnet service endpoint enabled. + |
+
Package v1api20240101preview contains API Schema definitions for the insights v1api20240101preview API group
+string alias)| Value | +Description | +
|---|---|
"2024-01-01-preview" |
++ |
+(Appears on:ScheduledQueryRule_Spec) +
+Actions to invoke when the alert fires.
+| Field | +Description | +
|---|---|
+actionGroupsReferences+ + +[]genruntime.ResourceReference + + + |
+
+ ActionGroupsReferences: Action Group resource Ids to invoke when the alert fires. + |
+
+actionProperties+ +map[string]string + + |
+
+ ActionProperties: The properties of an action properties. + |
+
+customProperties+ +map[string]string + + |
+
+ CustomProperties: The properties of an alert payload. + |
+
+(Appears on:ScheduledQueryRule_STATUS) +
+Actions to invoke when the alert fires.
+| Field | +Description | +
|---|---|
+actionGroups+ +[]string + + |
+
+ ActionGroups: Action Group resource Ids to invoke when the alert fires. + |
+
+actionProperties+ +map[string]string + + |
+
+ ActionProperties: The properties of an action properties. + |
+
+customProperties+ +map[string]string + + |
+
+ CustomProperties: The properties of an alert payload. + |
+
+(Appears on:ScheduledQueryRuleCriteria) +
+A condition of the scheduled query rule.
+| Field | +Description | +
|---|---|
+alertSensitivity+ +string + + |
+
+ AlertSensitivity: The extent of deviation required to trigger an alert. Allowed values are ‘Low’, ‘Medium’ and ‘High’. +This will affect how tight the threshold is to the metric series pattern. Relevant and required only for dynamic +threshold rules of the kind LogAlert. + |
+
+criterionType+ + +Condition_CriterionType + + + |
+
+ CriterionType: Specifies the type of threshold criteria + |
+
+dimensions+ + +[]Dimension + + + |
+
+ Dimensions: List of Dimensions conditions + |
+
+failingPeriods+ + +Condition_FailingPeriods + + + |
+
+ FailingPeriods: The minimum number of violations required within the selected lookback time window required to raise an +alert. Relevant only for rules of the kind LogAlert. + |
+
+ignoreDataBefore+ +string + + |
+
+ IgnoreDataBefore: Use this option to set the date from which to start learning the metric historical data and calculate +the dynamic thresholds (in ISO8601 format). Relevant only for dynamic threshold rules of the kind LogAlert. + |
+
+metricMeasureColumn+ +string + + |
+
+ MetricMeasureColumn: The column containing the metric measure number. Relevant only for rules of the kind LogAlert. + |
+
+metricName+ +string + + |
+
+ MetricName: The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric. + |
+
+operator+ + +Condition_Operator + + + |
+
+ Operator: The criteria operator. Relevant and required only for rules of the kind LogAlert. + |
+
+query+ +string + + |
+
+ Query: Log query alert + |
+
+resourceIdColumnReference+ + +genruntime.ResourceReference + + + |
+
+ ResourceIdColumnReference: The column containing the resource id. The content of the column must be a uri formatted as +resource id. Relevant only for rules of the kind LogAlert. + |
+
+threshold+ +float64 + + |
+
+ Threshold: the criteria threshold value that activates the alert. Relevant and required only for static threshold rules +of the kind LogAlert. + |
+
+timeAggregation+ + +Condition_TimeAggregation + + + |
+
+ TimeAggregation: Aggregation type. Relevant and required only for rules of the kind LogAlert. + |
+
string alias)+(Appears on:Condition) +
+| Value | +Description | +
|---|---|
"DynamicThresholdCriterion" |
++ |
"StaticThresholdCriterion" |
++ |
string alias)+(Appears on:Condition_STATUS) +
+| Value | +Description | +
|---|---|
"DynamicThresholdCriterion" |
++ |
"StaticThresholdCriterion" |
++ |
+(Appears on:Condition) +
+| Field | +Description | +
|---|---|
+minFailingPeriodsToAlert+ +int + + |
+
+ MinFailingPeriodsToAlert: The number of violations to trigger an alert. Should be smaller or equal to +numberOfEvaluationPeriods. Default value is 1 + |
+
+numberOfEvaluationPeriods+ +int + + |
+
+ NumberOfEvaluationPeriods: The number of aggregated lookback points. The lookback time window is calculated based on the +aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1 + |
+
+(Appears on:Condition_STATUS) +
+| Field | +Description | +
|---|---|
+minFailingPeriodsToAlert+ +int + + |
+
+ MinFailingPeriodsToAlert: The number of violations to trigger an alert. Should be smaller or equal to +numberOfEvaluationPeriods. Default value is 1 + |
+
+numberOfEvaluationPeriods+ +int + + |
+
+ NumberOfEvaluationPeriods: The number of aggregated lookback points. The lookback time window is calculated based on the +aggregation granularity (windowSize) and the selected number of aggregated points. Default value is 1 + |
+
string alias)+(Appears on:Condition) +
+| Value | +Description | +
|---|---|
"Equals" |
++ |
"GreaterOrLessThan" |
++ |
"GreaterThan" |
++ |
"GreaterThanOrEqual" |
++ |
"LessThan" |
++ |
"LessThanOrEqual" |
++ |
string alias)+(Appears on:Condition_STATUS) +
+| Value | +Description | +
|---|---|
"Equals" |
++ |
"GreaterOrLessThan" |
++ |
"GreaterThan" |
++ |
"GreaterThanOrEqual" |
++ |
"LessThan" |
++ |
"LessThanOrEqual" |
++ |
+(Appears on:ScheduledQueryRuleCriteria_STATUS) +
+A condition of the scheduled query rule.
+| Field | +Description | +
|---|---|
+alertSensitivity+ +string + + |
+
+ AlertSensitivity: The extent of deviation required to trigger an alert. Allowed values are ‘Low’, ‘Medium’ and ‘High’. +This will affect how tight the threshold is to the metric series pattern. Relevant and required only for dynamic +threshold rules of the kind LogAlert. + |
+
+criterionType+ + +Condition_CriterionType_STATUS + + + |
+
+ CriterionType: Specifies the type of threshold criteria + |
+
+dimensions+ + +[]Dimension_STATUS + + + |
+
+ Dimensions: List of Dimensions conditions + |
+
+failingPeriods+ + +Condition_FailingPeriods_STATUS + + + |
+
+ FailingPeriods: The minimum number of violations required within the selected lookback time window required to raise an +alert. Relevant only for rules of the kind LogAlert. + |
+
+ignoreDataBefore+ +string + + |
+
+ IgnoreDataBefore: Use this option to set the date from which to start learning the metric historical data and calculate +the dynamic thresholds (in ISO8601 format). Relevant only for dynamic threshold rules of the kind LogAlert. + |
+
+metricMeasureColumn+ +string + + |
+
+ MetricMeasureColumn: The column containing the metric measure number. Relevant only for rules of the kind LogAlert. + |
+
+metricName+ +string + + |
+
+ MetricName: The name of the metric to be sent. Relevant and required only for rules of the kind LogToMetric. + |
+
+operator+ + +Condition_Operator_STATUS + + + |
+
+ Operator: The criteria operator. Relevant and required only for rules of the kind LogAlert. + |
+
+query+ +string + + |
+
+ Query: Log query alert + |
+
+resourceIdColumn+ +string + + |
+
+ ResourceIdColumn: The column containing the resource id. The content of the column must be a uri formatted as resource +id. Relevant only for rules of the kind LogAlert. + |
+
+threshold+ +float64 + + |
+
+ Threshold: the criteria threshold value that activates the alert. Relevant and required only for static threshold rules +of the kind LogAlert. + |
+
+timeAggregation+ + +Condition_TimeAggregation_STATUS + + + |
+
+ TimeAggregation: Aggregation type. Relevant and required only for rules of the kind LogAlert. + |
+
string alias)+(Appears on:Condition) +
+| Value | +Description | +
|---|---|
"Average" |
++ |
"Count" |
++ |
"Maximum" |
++ |
"Minimum" |
++ |
"Total" |
++ |
string alias)+(Appears on:Condition_STATUS) +
+| Value | +Description | +
|---|---|
"Average" |
++ |
"Count" |
++ |
"Maximum" |
++ |
"Minimum" |
++ |
"Total" |
++ |
+(Appears on:Condition) +
+Dimension splitting and filtering definition
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: Name of the dimension + |
+
+operator+ + +Dimension_Operator + + + |
+
+ Operator: Operator for dimension values + |
+
+values+ +[]string + + |
+
+ Values: List of dimension values + |
+
string alias)+(Appears on:Dimension) +
+| Value | +Description | +
|---|---|
"Exclude" |
++ |
"Include" |
++ |
string alias)+(Appears on:Dimension_STATUS) +
+| Value | +Description | +
|---|---|
"Exclude" |
++ |
"Include" |
++ |
+(Appears on:Condition_STATUS) +
+Dimension splitting and filtering definition
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: Name of the dimension + |
+
+operator+ + +Dimension_Operator_STATUS + + + |
+
+ Operator: Operator for dimension values + |
+
+values+ +[]string + + |
+
+ Values: List of dimension values + |
+
+(Appears on:ScheduledQueryRule_Spec) +
+Identity for the resource.
+| Field | +Description | +
|---|---|
+type+ + +Identity_Type + + + |
+
+ Type: Type of managed service identity. + |
+
+userAssignedIdentities+ + +[]UserAssignedIdentityDetails + + + |
+
+ UserAssignedIdentities: The list of user identities associated with the resource. The user identity dictionary key +references will be ARM resource ids in the form: +‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’. + |
+
+(Appears on:ScheduledQueryRule_STATUS) +
+Identity for the resource.
+| Field | +Description | +
|---|---|
+principalId+ +string + + |
+
+ PrincipalId: The principal ID of resource identity. + |
+
+tenantId+ +string + + |
+
+ TenantId: The tenant ID of resource. + |
+
+type+ + +Identity_Type_STATUS + + + |
+
+ Type: Type of managed service identity. + |
+
+userAssignedIdentities+ + +map[string]./api/insights/v1api20240101preview.UserIdentityProperties_STATUS + + + |
+
+ UserAssignedIdentities: The list of user identities associated with the resource. The user identity dictionary key +references will be ARM resource ids in the form: +‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’. + |
+
string alias)+(Appears on:Identity) +
+| Value | +Description | +
|---|---|
"None" |
++ |
"SystemAssigned" |
++ |
"UserAssigned" |
++ |
string alias)+(Appears on:Identity_STATUS) +
+| Value | +Description | +
|---|---|
"None" |
++ |
"SystemAssigned" |
++ |
"UserAssigned" |
++ |
+(Appears on:ScheduledQueryRule_Spec) +
+TBD. Relevant only for rules of the kind LogAlert.
+| Field | +Description | +
|---|---|
+autoResolved+ +bool + + |
+
+ AutoResolved: The flag that indicates whether or not to auto resolve a fired alert. + |
+
+timeToResolve+ +string + + |
+
+ TimeToResolve: The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented +in ISO 8601 duration format. + |
+
+(Appears on:ScheduledQueryRule_STATUS) +
+TBD. Relevant only for rules of the kind LogAlert.
+| Field | +Description | +
|---|---|
+autoResolved+ +bool + + |
+
+ AutoResolved: The flag that indicates whether or not to auto resolve a fired alert. + |
+
+timeToResolve+ +string + + |
+
+ TimeToResolve: The duration a rule must evaluate as healthy before the fired alert is automatically resolved represented +in ISO 8601 duration format. + |
+
Generator information: +- Generated from: /monitor/resource-manager/Microsoft.Insights/preview/2024-01-01-preview/scheduledQueryRule_API.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/scheduledQueryRules/{ruleName} +
| Field | +Description | +||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||||||||||||||||||||||||||||
+spec+ + +ScheduledQueryRule_Spec + + + |
+
+ + +
|
+||||||||||||||||||||||||||||||||||||||||||||||
+status+ + +ScheduledQueryRule_STATUS + + + |
++ | +
+(Appears on:ScheduledQueryRule_Spec) +
+The rule criteria that defines the conditions of the scheduled query rule.
+| Field | +Description | +
|---|---|
+allOf+ + +[]Condition + + + |
+
+ AllOf: A list of conditions to evaluate against the specified scopes + |
+
+(Appears on:ScheduledQueryRule_STATUS) +
+The rule criteria that defines the conditions of the scheduled query rule.
+| Field | +Description | +
|---|---|
+allOf+ + +[]Condition_STATUS + + + |
+
+ AllOf: A list of conditions to evaluate against the specified scopes + |
+
+(Appears on:ScheduledQueryRule_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
int alias)+(Appears on:ScheduledQueryRule_Spec) +
+| Value | +Description | +
|---|---|
0 |
++ |
1 |
++ |
2 |
++ |
3 |
++ |
4 |
++ |
int alias)+(Appears on:ScheduledQueryRule_STATUS) +
+| Value | +Description | +
|---|---|
0 |
++ |
1 |
++ |
2 |
++ |
3 |
++ |
4 |
++ |
string alias)+(Appears on:ScheduledQueryRule_STATUS) +
+| Value | +Description | +
|---|---|
"EventLogAlert" |
++ |
"LogAlert" |
++ |
"LogToMetric" |
++ |
string alias)+(Appears on:ScheduledQueryRule_Spec) +
+| Value | +Description | +
|---|---|
"EventLogAlert" |
++ |
"LogAlert" |
++ |
"LogToMetric" |
++ |
+(Appears on:ScheduledQueryRule) +
+| Field | +Description | +
|---|---|
+actions+ + +Actions_STATUS + + + |
+
+ Actions: Actions to invoke when the alert fires. + |
+
+autoMitigate+ +bool + + |
+
+ AutoMitigate: The flag that indicates whether the alert should be automatically resolved or not. The default is true. +Relevant only for rules of the kind LogAlert. + |
+
+checkWorkspaceAlertsStorageConfigured+ +bool + + |
+
+ CheckWorkspaceAlertsStorageConfigured: The flag which indicates whether this scheduled query rule should be stored in +the customer’s storage. The default is false. Relevant only for rules of the kind LogAlert. + |
+
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+createdWithApiVersion+ +string + + |
+
+ CreatedWithApiVersion: The api-version used when creating this alert rule + |
+
+criteria+ + +ScheduledQueryRuleCriteria_STATUS + + + |
+
+ Criteria: The rule criteria that defines the conditions of the scheduled query rule. + |
+
+description+ +string + + |
+
+ Description: The description of the scheduled query rule. + |
+
+displayName+ +string + + |
+
+ DisplayName: The display name of the alert rule + |
+
+enabled+ +bool + + |
+
+ Enabled: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false + |
+
+etag+ +string + + |
+
+ Etag: The etag field is not required. If it is provided in the response body, it must also be provided as a header per +the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. +HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and +If-Range (section 14.27) header fields. + |
+
+evaluationFrequency+ +string + + |
+
+ EvaluationFrequency: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant +and required only for rules of the kind LogAlert. + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} + |
+
+identity+ + +Identity_STATUS + + + |
+
+ Identity: The identity of the resource. + |
+
+isLegacyLogAnalyticsRule+ +bool + + |
+
+ IsLegacyLogAnalyticsRule: True if alert rule is legacy Log Analytic rule + |
+
+isWorkspaceAlertsStorageConfigured+ +bool + + |
+
+ IsWorkspaceAlertsStorageConfigured: The flag which indicates whether this scheduled query rule has been configured to be +stored in the customer’s storage. The default is false. + |
+
+kind+ + +ScheduledQueryRule_Kind_STATUS + + + |
+
+ Kind: Indicates the type of scheduled query rule. The default is LogAlert. + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+muteActionsDuration+ +string + + |
+
+ MuteActionsDuration: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. +Relevant only for rules of the kind LogAlert. + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+overrideQueryTimeRange+ +string + + |
+
+ OverrideQueryTimeRange: If specified then overrides the query time range (default is +WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert. + |
+
+resolveConfiguration+ + +RuleResolveConfiguration_STATUS + + + |
+
+ ResolveConfiguration: Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert. + |
+
+scopes+ +[]string + + |
+
+ Scopes: The list of resource id’s that this scheduled query rule is scoped to. + |
+
+severity+ + +ScheduledQueryRuleProperties_Severity_STATUS + + + |
+
+ Severity: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only +for rules of the kind LogAlert. + |
+
+skipQueryValidation+ +bool + + |
+
+ SkipQueryValidation: The flag which indicates whether the provided query should be validated or not. The default is +false. Relevant only for rules of the kind LogAlert. + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: SystemData of ScheduledQueryRule. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+targetResourceTypes+ +[]string + + |
+
+ TargetResourceTypes: List of resource type of the target resource(s) on which the alert is created/updated. For example +if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert +will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of +the kind LogAlert + |
+
+type+ +string + + |
+
+ Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” + |
+
+windowSize+ +string + + |
+
+ WindowSize: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). +Relevant and required only for rules of the kind LogAlert. + |
+
+(Appears on:ScheduledQueryRule) +
+| Field | +Description | +
|---|---|
+actions+ + +Actions + + + |
+
+ Actions: Actions to invoke when the alert fires. + |
+
+autoMitigate+ +bool + + |
+
+ AutoMitigate: The flag that indicates whether the alert should be automatically resolved or not. The default is true. +Relevant only for rules of the kind LogAlert. + |
+
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+checkWorkspaceAlertsStorageConfigured+ +bool + + |
+
+ CheckWorkspaceAlertsStorageConfigured: The flag which indicates whether this scheduled query rule should be stored in +the customer’s storage. The default is false. Relevant only for rules of the kind LogAlert. + |
+
+criteria+ + +ScheduledQueryRuleCriteria + + + |
+
+ Criteria: The rule criteria that defines the conditions of the scheduled query rule. + |
+
+description+ +string + + |
+
+ Description: The description of the scheduled query rule. + |
+
+displayName+ +string + + |
+
+ DisplayName: The display name of the alert rule + |
+
+enabled+ +bool + + |
+
+ Enabled: The flag which indicates whether this scheduled query rule is enabled. Value should be true or false + |
+
+evaluationFrequency+ +string + + |
+
+ EvaluationFrequency: How often the scheduled query rule is evaluated represented in ISO 8601 duration format. Relevant +and required only for rules of the kind LogAlert. + |
+
+identity+ + +Identity + + + |
+
+ Identity: The identity of the resource. + |
+
+kind+ + +ScheduledQueryRule_Kind_Spec + + + |
+
+ Kind: Indicates the type of scheduled query rule. The default is LogAlert. + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+muteActionsDuration+ +string + + |
+
+ MuteActionsDuration: Mute actions for the chosen period of time (in ISO 8601 duration format) after the alert is fired. +Relevant only for rules of the kind LogAlert. + |
+
+operatorSpec+ + +ScheduledQueryRuleOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+overrideQueryTimeRange+ +string + + |
+
+ OverrideQueryTimeRange: If specified then overrides the query time range (default is +WindowSize*NumberOfEvaluationPeriods). Relevant only for rules of the kind LogAlert. + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a resources.azure.com/ResourceGroup resource + |
+
+resolveConfiguration+ + +RuleResolveConfiguration + + + |
+
+ ResolveConfiguration: Defines the configuration for resolving fired alerts. Relevant only for rules of the kind LogAlert. + |
+
+scopesReferences+ + +[]genruntime.ResourceReference + + + |
+
+ ScopesReferences: The list of resource id’s that this scheduled query rule is scoped to. + |
+
+severity+ + +ScheduledQueryRuleProperties_Severity + + + |
+
+ Severity: Severity of the alert. Should be an integer between [0-4]. Value of 0 is severest. Relevant and required only +for rules of the kind LogAlert. + |
+
+skipQueryValidation+ +bool + + |
+
+ SkipQueryValidation: The flag which indicates whether the provided query should be validated or not. The default is +false. Relevant only for rules of the kind LogAlert. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+targetResourceTypes+ +[]string + + |
+
+ TargetResourceTypes: List of resource type of the target resource(s) on which the alert is created/updated. For example +if the scope is a resource group and targetResourceTypes is Microsoft.Compute/virtualMachines, then a different alert +will be fired for each virtual machine in the resource group which meet the alert criteria. Relevant only for rules of +the kind LogAlert + |
+
+windowSize+ +string + + |
+
+ WindowSize: The period of time (in ISO 8601 duration format) on which the Alert query will be executed (bin size). +Relevant and required only for rules of the kind LogAlert. + |
+
string alias)+(Appears on:SystemData_STATUS) +
+| Value | +Description | +
|---|---|
"Application" |
++ |
"Key" |
++ |
"ManagedIdentity" |
++ |
"User" |
++ |
string alias)+(Appears on:SystemData_STATUS) +
+| Value | +Description | +
|---|---|
"Application" |
++ |
"Key" |
++ |
"ManagedIdentity" |
++ |
"User" |
++ |
+(Appears on:ScheduledQueryRule_STATUS) +
+Metadata pertaining to creation and last modification of the resource.
+| Field | +Description | +
|---|---|
+createdAt+ +string + + |
+
+ CreatedAt: The timestamp of resource creation (UTC). + |
+
+createdBy+ +string + + |
+
+ CreatedBy: The identity that created the resource. + |
+
+createdByType+ + +SystemData_CreatedByType_STATUS + + + |
+
+ CreatedByType: The type of identity that created the resource. + |
+
+lastModifiedAt+ +string + + |
+
+ LastModifiedAt: The timestamp of resource last modification (UTC) + |
+
+lastModifiedBy+ +string + + |
+
+ LastModifiedBy: The identity that last modified the resource. + |
+
+lastModifiedByType+ + +SystemData_LastModifiedByType_STATUS + + + |
+
+ LastModifiedByType: The type of identity that last modified the resource. + |
+
+(Appears on:Identity) +
+Information about the user assigned identity for the resource
+| Field | +Description | +
|---|---|
+reference+ + +genruntime.ResourceReference + + + |
++ | +
+(Appears on:Identity_STATUS) +
+User assigned identity properties.
+| Field | +Description | +
|---|---|
+clientId+ +string + + |
+
+ ClientId: The client id of user assigned identity. + |
+
+principalId+ +string + + |
+
+ PrincipalId: The principal id of user assigned identity. + |
+
Package v1api20230901 contains API Schema definitions for the notificationhubs v1api20230901 API group
+string alias)| Value | +Description | +
|---|---|
"2023-09-01" |
++ |
string alias)+(Appears on:IpRule, PublicInternetAuthorizationRule, SharedAccessAuthorizationRuleProperties) +
+Defines values for AccessRights.
+| Value | +Description | +
|---|---|
"Listen" |
++ |
"Manage" |
++ |
"Send" |
++ |
string alias)+(Appears on:IpRule_STATUS, PublicInternetAuthorizationRule_STATUS, SharedAccessAuthorizationRuleProperties_STATUS) +
+Defines values for AccessRights.
+| Value | +Description | +
|---|---|
"Listen" |
++ |
"Manage" |
++ |
"Send" |
++ |
+(Appears on:NotificationHubProperties, PnsCredentials) +
+Description of a NotificationHub AdmCredential.
+| Field | +Description | +
|---|---|
+properties+ + +AdmCredentialProperties + + + |
+
+ Properties: Description of a NotificationHub AdmCredential. + |
+
+(Appears on:AdmCredential) +
+Description of a NotificationHub AdmCredential.
+| Field | +Description | +
|---|---|
+authTokenUrl+ + +genruntime.SecretReference + + + |
+
+ AuthTokenUrl: Gets or sets the URL of the authorization token. + |
+
+clientId+ + +genruntime.SecretReference + + + |
+
+ ClientId: Gets or sets the client identifier. + |
+
+clientSecret+ + +genruntime.SecretReference + + + |
+
+ ClientSecret: Gets or sets the credential secret access key. + |
+
+(Appears on:AdmCredential_STATUS) +
+Description of a NotificationHub AdmCredential.
++(Appears on:NotificationHubProperties_STATUS, PnsCredentials_STATUS) +
+Description of a NotificationHub AdmCredential.
+| Field | +Description | +
|---|---|
+properties+ + +AdmCredentialProperties_STATUS + + + |
+
+ Properties: Description of a NotificationHub AdmCredential. + |
+
+(Appears on:NotificationHubProperties, PnsCredentials) +
+Description of a NotificationHub ApnsCredential.
+| Field | +Description | +
|---|---|
+properties+ + +ApnsCredentialProperties + + + |
+
+ Properties: Description of a NotificationHub ApnsCredential. + |
+
+(Appears on:ApnsCredential) +
+Description of a NotificationHub ApnsCredential.
+| Field | +Description | +
|---|---|
+apnsCertificate+ + +genruntime.SecretReference + + + |
+
+ ApnsCertificate: Gets or sets the APNS certificate. + |
+
+appId+ + +genruntime.SecretReference + + + |
+
+ AppId: Gets or sets the issuer (iss) registered claim key, whose value is +your 10-character Team ID, obtained from your developer account + |
+
+appName+ + +genruntime.SecretReference + + + |
+
+ AppName: Gets or sets the name of the application + |
+
+certificateKey+ + +genruntime.SecretReference + + + |
+
+ CertificateKey: Gets or sets the certificate key. + |
+
+endpoint+ + +genruntime.SecretReference + + + |
+
+ Endpoint: Gets or sets the endpoint of this credential. + |
+
+keyId+ + +genruntime.SecretReference + + + |
+
+ KeyId: Gets or sets a 10-character key identifier (kid) key, obtained from +your developer account + |
+
+thumbprint+ + +genruntime.SecretReference + + + |
+
+ Thumbprint: Gets or sets the APNS certificate Thumbprint + |
+
+token+ + +genruntime.SecretReference + + + |
+
+ Token: Gets or sets provider Authentication Token, obtained through your +developer account + |
+
+(Appears on:ApnsCredential_STATUS) +
+Description of a NotificationHub ApnsCredential.
++(Appears on:NotificationHubProperties_STATUS, PnsCredentials_STATUS) +
+Description of a NotificationHub ApnsCredential.
+| Field | +Description | +
|---|---|
+properties+ + +ApnsCredentialProperties_STATUS + + + |
+
+ Properties: Description of a NotificationHub ApnsCredential. + |
+
+(Appears on:NotificationHubProperties, PnsCredentials) +
+Description of a NotificationHub BaiduCredential.
+| Field | +Description | +
|---|---|
+properties+ + +BaiduCredentialProperties + + + |
+
+ Properties: Description of a NotificationHub BaiduCredential. + |
+
+(Appears on:BaiduCredential) +
+Description of a NotificationHub BaiduCredential.
+| Field | +Description | +
|---|---|
+baiduApiKey+ + +genruntime.SecretReference + + + |
+
+ BaiduApiKey: Gets or sets baidu Api Key. + |
+
+baiduEndPoint+ + +genruntime.SecretReference + + + |
+
+ BaiduEndPoint: Gets or sets baidu Endpoint. + |
+
+baiduSecretKey+ + +genruntime.SecretReference + + + |
+
+ BaiduSecretKey: Gets or sets baidu Secret Key + |
+
+(Appears on:BaiduCredential_STATUS) +
+Description of a NotificationHub BaiduCredential.
++(Appears on:NotificationHubProperties_STATUS, PnsCredentials_STATUS) +
+Description of a NotificationHub BaiduCredential.
+| Field | +Description | +
|---|---|
+properties+ + +BaiduCredentialProperties_STATUS + + + |
+
+ Properties: Description of a NotificationHub BaiduCredential. + |
+
+(Appears on:NotificationHubProperties, PnsCredentials) +
+Description of a NotificationHub BrowserCredential.
+| Field | +Description | +
|---|---|
+properties+ + +BrowserCredentialProperties + + + |
+
+ Properties: Description of a NotificationHub BrowserCredential. + |
+
+(Appears on:BrowserCredential) +
+Description of a NotificationHub BrowserCredential.
+| Field | +Description | +
|---|---|
+subject+ + +genruntime.SecretReference + + + |
+
+ Subject: Gets or sets web push subject. + |
+
+vapidPrivateKey+ + +genruntime.SecretReference + + + |
+
+ VapidPrivateKey: Gets or sets VAPID private key. + |
+
+vapidPublicKey+ + +genruntime.SecretReference + + + |
+
+ VapidPublicKey: Gets or sets VAPID public key. + |
+
+(Appears on:BrowserCredential_STATUS) +
+Description of a NotificationHub BrowserCredential.
++(Appears on:NotificationHubProperties_STATUS, PnsCredentials_STATUS) +
+Description of a NotificationHub BrowserCredential.
+| Field | +Description | +
|---|---|
+properties+ + +BrowserCredentialProperties_STATUS + + + |
+
+ Properties: Description of a NotificationHub BrowserCredential. + |
+
+(Appears on:NotificationHubProperties, PnsCredentials) +
+Description of a NotificationHub GcmCredential.
+| Field | +Description | +
|---|---|
+properties+ + +GcmCredentialProperties + + + |
+
+ Properties: Description of a NotificationHub GcmCredential. + |
+
+(Appears on:GcmCredential) +
+Description of a NotificationHub GcmCredential.
+| Field | +Description | +
|---|---|
+gcmEndpoint+ + +genruntime.SecretReference + + + |
+
+ GcmEndpoint: Gets or sets the GCM endpoint. + |
+
+googleApiKey+ + +genruntime.SecretReference + + + |
+
+ GoogleApiKey: Gets or sets the Google API key. + |
+
+(Appears on:GcmCredential_STATUS) +
+Description of a NotificationHub GcmCredential.
++(Appears on:NotificationHubProperties_STATUS, PnsCredentials_STATUS) +
+Description of a NotificationHub GcmCredential.
+| Field | +Description | +
|---|---|
+properties+ + +GcmCredentialProperties_STATUS + + + |
+
+ Properties: Description of a NotificationHub GcmCredential. + |
+
+(Appears on:NetworkAcls) +
+A network authorization rule that filters traffic based on IP address.
+| Field | +Description | +
|---|---|
+ipMask+ +string + + |
+
+ IpMask: IP mask. + |
+
+rights+ + +[]AccessRights + + + |
+
+ Rights: List of access rights. + |
+
+(Appears on:NetworkAcls_STATUS) +
+A network authorization rule that filters traffic based on IP address.
+| Field | +Description | +
|---|---|
+ipMask+ +string + + |
+
+ IpMask: IP mask. + |
+
+rights+ + +[]AccessRights_STATUS + + + |
+
+ Rights: List of access rights. + |
+
+(Appears on:NotificationHubProperties, PnsCredentials) +
+Description of a NotificationHub MpnsCredential.
+| Field | +Description | +
|---|---|
+properties+ + +MpnsCredentialProperties + + + |
+
+ Properties: Description of a NotificationHub MpnsCredential. + |
+
+(Appears on:MpnsCredential) +
+Description of a NotificationHub MpnsCredential.
+| Field | +Description | +
|---|---|
+certificateKey+ + +genruntime.SecretReference + + + |
+
+ CertificateKey: Gets or sets the certificate key for this credential. + |
+
+mpnsCertificate+ + +genruntime.SecretReference + + + |
+
+ MpnsCertificate: Gets or sets the MPNS certificate. + |
+
+thumbprint+ + +genruntime.SecretReference + + + |
+
+ Thumbprint: Gets or sets the MPNS certificate Thumbprint + |
+
+(Appears on:MpnsCredential_STATUS) +
+Description of a NotificationHub MpnsCredential.
++(Appears on:NotificationHubProperties_STATUS, PnsCredentials_STATUS) +
+Description of a NotificationHub MpnsCredential.
+| Field | +Description | +
|---|---|
+properties+ + +MpnsCredentialProperties_STATUS + + + |
+
+ Properties: Description of a NotificationHub MpnsCredential. + |
+
Generator information: +- Generated from: /notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName} +
| Field | +Description | +||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||
+spec+ + +Namespace_Spec + + + |
+
+ + +
|
+||||||||||||||
+status+ + +Namespace_STATUS + + + |
++ | +
+(Appears on:NamespaceOperatorSpec) +
+| Field | +Description | +
|---|---|
+serviceBusEndpoint+ + +genruntime.ConfigMapDestination + + + |
+
+ ServiceBusEndpoint: indicates where the ServiceBusEndpoint config map should be placed. If omitted, no config map will +be created. + |
+
+(Appears on:NamespaceOperatorSpec) +
+| Field | +Description | +
|---|---|
+primaryConnectionString+ + +genruntime.SecretDestination + + + |
+
+ PrimaryConnectionString: indicates where the PrimaryConnectionString secret should be placed. If omitted, the secret +will not be retrieved from Azure. + |
+
+primaryKey+ + +genruntime.SecretDestination + + + |
+
+ PrimaryKey: indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from +Azure. + |
+
+secondaryConnectionString+ + +genruntime.SecretDestination + + + |
+
+ SecondaryConnectionString: indicates where the SecondaryConnectionString secret should be placed. If omitted, the secret +will not be retrieved from Azure. + |
+
+secondaryKey+ + +genruntime.SecretDestination + + + |
+
+ SecondaryKey: indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved +from Azure. + |
+
+(Appears on:Namespace_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+configMaps+ + +NamespaceOperatorConfigMaps + + + |
+
+ ConfigMaps: configures where to place operator written ConfigMaps. + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+secrets+ + +NamespaceOperatorSecrets + + + |
+
+ Secrets: configures where to place Azure generated secrets. + |
+
+(Appears on:Namespace_Spec) +
+Represents namespace properties.
+| Field | +Description | +
|---|---|
+dataCenter+ +string + + |
+
+ DataCenter: Deprecated. + |
+
+namespaceType+ + +NamespaceType + + + |
+
+ NamespaceType: Defines values for NamespaceType. + |
+
+networkAcls+ + +NetworkAcls + + + |
+
+ NetworkAcls: A collection of network authorization rules. + |
+
+pnsCredentials+ + +PnsCredentials + + + |
+
+ PnsCredentials: Collection of Notification Hub or Notification Hub Namespace PNS credentials. + |
+
+publicNetworkAccess+ + +PublicNetworkAccess + + + |
+
+ PublicNetworkAccess: Type of public network access. + |
+
+replicationRegion+ + +ReplicationRegion + + + |
+
+ ReplicationRegion: Allowed replication region + |
+
+scaleUnit+ +string + + |
+
+ ScaleUnit: Gets or sets scaleUnit where the namespace gets created + |
+
+zoneRedundancy+ + +ZoneRedundancyPreference + + + |
+
+ ZoneRedundancy: Namespace SKU name. + |
+
+(Appears on:Namespace_STATUS) +
+Represents namespace properties.
+| Field | +Description | +
|---|---|
+createdAt+ +string + + |
+
+ CreatedAt: Time when the namespace was created. + |
+
+critical+ +bool + + |
+
+ Critical: Gets or sets whether or not the namespace is set as Critical. + |
+
+dataCenter+ +string + + |
+
+ DataCenter: Deprecated. + |
+
+enabled+ +bool + + |
+
+ Enabled: Gets or sets whether or not the namespace is currently enabled. + |
+
+metricId+ +string + + |
+
+ MetricId: Azure Insights Metrics id. + |
+
+name+ +string + + |
+
+ Name: Name of the Notification Hubs namespace. This is immutable property, set automatically +by the service when the namespace is created. + |
+
+namespaceType+ + +NamespaceType_STATUS + + + |
+
+ NamespaceType: Defines values for NamespaceType. + |
+
+networkAcls+ + +NetworkAcls_STATUS + + + |
+
+ NetworkAcls: A collection of network authorization rules. + |
+
+pnsCredentials+ + +PnsCredentials_STATUS + + + |
+
+ PnsCredentials: Collection of Notification Hub or Notification Hub Namespace PNS credentials. + |
+
+privateEndpointConnections+ + +[]PrivateEndpointConnectionResource_STATUS + + + |
+
+ PrivateEndpointConnections: Private Endpoint Connections for namespace + |
+
+provisioningState+ + +OperationProvisioningState_STATUS + + + |
+
+ ProvisioningState: Defines values for OperationProvisioningState. + |
+
+publicNetworkAccess+ + +PublicNetworkAccess_STATUS + + + |
+
+ PublicNetworkAccess: Type of public network access. + |
+
+region+ +string + + |
+
+ Region: Region. The value is always set to the same value as Namespace.Location, so we are deprecating +this property. + |
+
+replicationRegion+ + +ReplicationRegion_STATUS + + + |
+
+ ReplicationRegion: Allowed replication region + |
+
+scaleUnit+ +string + + |
+
+ ScaleUnit: Gets or sets scaleUnit where the namespace gets created + |
+
+serviceBusEndpoint+ +string + + |
+
+ ServiceBusEndpoint: Gets or sets endpoint you can use to perform NotificationHub +operations. + |
+
+status+ + +NamespaceStatus_STATUS + + + |
+
+ Status: Namespace status. + |
+
+subscriptionId+ +string + + |
+
+ SubscriptionId: Namespace subscription id. + |
+
+updatedAt+ +string + + |
+
+ UpdatedAt: Time when the namespace was updated. + |
+
+zoneRedundancy+ + +ZoneRedundancyPreference_STATUS + + + |
+
+ ZoneRedundancy: Namespace SKU name. + |
+
string alias)+(Appears on:NamespaceProperties_STATUS) +
+Namespace status.
+| Value | +Description | +
|---|---|
"Created" |
++ |
"Creating" |
++ |
"Deleting" |
++ |
"Suspended" |
++ |
string alias)+(Appears on:NamespaceProperties) +
+Defines values for NamespaceType.
+| Value | +Description | +
|---|---|
"Messaging" |
++ |
"NotificationHub" |
++ |
string alias)+(Appears on:NamespaceProperties_STATUS) +
+Defines values for NamespaceType.
+| Value | +Description | +
|---|---|
"Messaging" |
++ |
"NotificationHub" |
++ |
+(Appears on:Namespace) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. E.g. +“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+properties+ + +NamespaceProperties_STATUS + + + |
+
+ Properties: Represents namespace properties. + |
+
+sku+ + +Sku_STATUS + + + |
+
+ Sku: The Sku description for a namespace + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” + |
+
+(Appears on:Namespace) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+operatorSpec+ + +NamespaceOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a resources.azure.com/ResourceGroup resource + |
+
+properties+ + +NamespaceProperties + + + |
+
+ Properties: Represents namespace properties. + |
+
+sku+ + +Sku + + + |
+
+ Sku: The Sku description for a namespace + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
Generator information: +- Generated from: /notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/authorizationRules/{authorizationRuleName} +
| Field | +Description | +||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||
+spec+ + +NamespacesAuthorizationRule_Spec + + + |
+
+ + +
|
+||||||||||||
+status+ + +NamespacesAuthorizationRule_STATUS + + + |
++ | +
+(Appears on:NamespacesAuthorizationRule_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:NamespacesAuthorizationRule) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. E.g. +“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” + |
+
+location+ +string + + |
+
+ Location: Deprecated - only for compatibility. + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+properties+ + +SharedAccessAuthorizationRuleProperties_STATUS + + + |
+
+ Properties: SharedAccessAuthorizationRule properties. + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Deprecated - only for compatibility. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” + |
+
+(Appears on:NamespacesAuthorizationRule) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+location+ +string + + |
+
+ Location: Deprecated - only for compatibility. + |
+
+operatorSpec+ + +NamespacesAuthorizationRuleOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a notificationhubs.azure.com/Namespace resource + |
+
+properties+ + +SharedAccessAuthorizationRuleProperties + + + |
+
+ Properties: SharedAccessAuthorizationRule properties. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Deprecated - only for compatibility. + |
+
+(Appears on:NamespaceProperties) +
+A collection of network authorization rules.
+| Field | +Description | +
|---|---|
+ipRules+ + +[]IpRule + + + |
+
+ IpRules: List of IP rules. + |
+
+publicNetworkRule+ + +PublicInternetAuthorizationRule + + + |
+
+ PublicNetworkRule: A default (public Internet) network authorization rule, which contains rights if no other network +rule matches. + |
+
+(Appears on:NamespaceProperties_STATUS) +
+A collection of network authorization rules.
+| Field | +Description | +
|---|---|
+ipRules+ + +[]IpRule_STATUS + + + |
+
+ IpRules: List of IP rules. + |
+
+publicNetworkRule+ + +PublicInternetAuthorizationRule_STATUS + + + |
+
+ PublicNetworkRule: A default (public Internet) network authorization rule, which contains rights if no other network +rule matches. + |
+
Generator information: +- Generated from: /notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName} +
| Field | +Description | +||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||
+spec+ + +NotificationHub_Spec + + + |
+
+ + +
|
+||||||||||||||
+status+ + +NotificationHub_STATUS + + + |
++ | +
+(Appears on:NotificationHubOperatorSpec) +
+| Field | +Description | +
|---|---|
+primaryConnectionString+ + +genruntime.SecretDestination + + + |
+
+ PrimaryConnectionString: indicates where the PrimaryConnectionString secret should be placed. If omitted, the secret +will not be retrieved from Azure. + |
+
+primaryKey+ + +genruntime.SecretDestination + + + |
+
+ PrimaryKey: indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from +Azure. + |
+
+secondaryConnectionString+ + +genruntime.SecretDestination + + + |
+
+ SecondaryConnectionString: indicates where the SecondaryConnectionString secret should be placed. If omitted, the secret +will not be retrieved from Azure. + |
+
+secondaryKey+ + +genruntime.SecretDestination + + + |
+
+ SecondaryKey: indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved +from Azure. + |
+
+(Appears on:NotificationHub_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+secrets+ + +NotificationHubOperatorSecrets + + + |
+
+ Secrets: configures where to place Azure generated secrets. + |
+
+(Appears on:NotificationHub_Spec) +
+NotificationHub properties.
+| Field | +Description | +
|---|---|
+admCredential+ + +AdmCredential + + + |
+
+ AdmCredential: Description of a NotificationHub AdmCredential. + |
+
+apnsCredential+ + +ApnsCredential + + + |
+
+ ApnsCredential: Description of a NotificationHub ApnsCredential. + |
+
+baiduCredential+ + +BaiduCredential + + + |
+
+ BaiduCredential: Description of a NotificationHub BaiduCredential. + |
+
+browserCredential+ + +BrowserCredential + + + |
+
+ BrowserCredential: Description of a NotificationHub BrowserCredential. + |
+
+gcmCredential+ + +GcmCredential + + + |
+
+ GcmCredential: Description of a NotificationHub GcmCredential. + |
+
+mpnsCredential+ + +MpnsCredential + + + |
+
+ MpnsCredential: Description of a NotificationHub MpnsCredential. + |
+
+name+ +string + + |
+
+ Name: Gets or sets the NotificationHub name. + |
+
+registrationTtl+ +string + + |
+
+ RegistrationTtl: Gets or sets the RegistrationTtl of the created NotificationHub + |
+
+wnsCredential+ + +WnsCredential + + + |
+
+ WnsCredential: Description of a NotificationHub WnsCredential. + |
+
+xiaomiCredential+ + +XiaomiCredential + + + |
+
+ XiaomiCredential: Description of a NotificationHub XiaomiCredential. + |
+
+(Appears on:NotificationHub_STATUS) +
+NotificationHub properties.
+| Field | +Description | +
|---|---|
+admCredential+ + +AdmCredential_STATUS + + + |
+
+ AdmCredential: Description of a NotificationHub AdmCredential. + |
+
+apnsCredential+ + +ApnsCredential_STATUS + + + |
+
+ ApnsCredential: Description of a NotificationHub ApnsCredential. + |
+
+authorizationRules+ + +[]SharedAccessAuthorizationRuleProperties_STATUS + + + |
+
+ AuthorizationRules: Gets or sets the AuthorizationRules of the created NotificationHub + |
+
+baiduCredential+ + +BaiduCredential_STATUS + + + |
+
+ BaiduCredential: Description of a NotificationHub BaiduCredential. + |
+
+browserCredential+ + +BrowserCredential_STATUS + + + |
+
+ BrowserCredential: Description of a NotificationHub BrowserCredential. + |
+
+dailyMaxActiveDevices+ +int + + |
++ | +
+gcmCredential+ + +GcmCredential_STATUS + + + |
+
+ GcmCredential: Description of a NotificationHub GcmCredential. + |
+
+mpnsCredential+ + +MpnsCredential_STATUS + + + |
+
+ MpnsCredential: Description of a NotificationHub MpnsCredential. + |
+
+name+ +string + + |
+
+ Name: Gets or sets the NotificationHub name. + |
+
+registrationTtl+ +string + + |
+
+ RegistrationTtl: Gets or sets the RegistrationTtl of the created NotificationHub + |
+
+wnsCredential+ + +WnsCredential_STATUS + + + |
+
+ WnsCredential: Description of a NotificationHub WnsCredential. + |
+
+xiaomiCredential+ + +XiaomiCredential_STATUS + + + |
+
+ XiaomiCredential: Description of a NotificationHub XiaomiCredential. + |
+
+(Appears on:NotificationHub) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. E.g. +“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+properties+ + +NotificationHubProperties_STATUS + + + |
+
+ Properties: NotificationHub properties. + |
+
+sku+ + +Sku_STATUS + + + |
+
+ Sku: The Sku description for a namespace + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” + |
+
+(Appears on:NotificationHub) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+operatorSpec+ + +NotificationHubOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a notificationhubs.azure.com/Namespace resource + |
+
+properties+ + +NotificationHubProperties + + + |
+
+ Properties: NotificationHub properties. + |
+
+sku+ + +Sku + + + |
+
+ Sku: The Sku description for a namespace + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
Generator information: +- Generated from: /notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2023-09-01/notificationhubs.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NotificationHubs/namespaces/{namespaceName}/notificationHubs/{notificationHubName}/authorizationRules/{authorizationRuleName} +
| Field | +Description | +||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||
+spec+ + +NotificationHubsAuthorizationRule_Spec + + + |
+
+ + +
|
+||||||||||||
+status+ + +NotificationHubsAuthorizationRule_STATUS + + + |
++ | +
+(Appears on:NotificationHubsAuthorizationRule_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:NotificationHubsAuthorizationRule) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. E.g. +“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” + |
+
+location+ +string + + |
+
+ Location: Deprecated - only for compatibility. + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+properties+ + +SharedAccessAuthorizationRuleProperties_STATUS + + + |
+
+ Properties: SharedAccessAuthorizationRule properties. + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Deprecated - only for compatibility. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” + |
+
+(Appears on:NotificationHubsAuthorizationRule) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+location+ +string + + |
+
+ Location: Deprecated - only for compatibility. + |
+
+operatorSpec+ + +NotificationHubsAuthorizationRuleOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a notificationhubs.azure.com/NotificationHub resource + |
+
+properties+ + +SharedAccessAuthorizationRuleProperties + + + |
+
+ Properties: SharedAccessAuthorizationRule properties. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Deprecated - only for compatibility. + |
+
string alias)+(Appears on:NamespaceProperties_STATUS) +
+Defines values for OperationProvisioningState.
+| Value | +Description | +
|---|---|
"Canceled" |
++ |
"Disabled" |
++ |
"Failed" |
++ |
"InProgress" |
++ |
"Pending" |
++ |
"Succeeded" |
++ |
"Unknown" |
++ |
+(Appears on:NamespaceProperties) +
+Collection of Notification Hub or Notification Hub Namespace PNS credentials.
+| Field | +Description | +
|---|---|
+admCredential+ + +AdmCredential + + + |
+
+ AdmCredential: Description of a NotificationHub AdmCredential. + |
+
+apnsCredential+ + +ApnsCredential + + + |
+
+ ApnsCredential: Description of a NotificationHub ApnsCredential. + |
+
+baiduCredential+ + +BaiduCredential + + + |
+
+ BaiduCredential: Description of a NotificationHub BaiduCredential. + |
+
+browserCredential+ + +BrowserCredential + + + |
+
+ BrowserCredential: Description of a NotificationHub BrowserCredential. + |
+
+gcmCredential+ + +GcmCredential + + + |
+
+ GcmCredential: Description of a NotificationHub GcmCredential. + |
+
+mpnsCredential+ + +MpnsCredential + + + |
+
+ MpnsCredential: Description of a NotificationHub MpnsCredential. + |
+
+wnsCredential+ + +WnsCredential + + + |
+
+ WnsCredential: Description of a NotificationHub WnsCredential. + |
+
+xiaomiCredential+ + +XiaomiCredential + + + |
+
+ XiaomiCredential: Description of a NotificationHub XiaomiCredential. + |
+
+(Appears on:NamespaceProperties_STATUS) +
+Collection of Notification Hub or Notification Hub Namespace PNS credentials.
+| Field | +Description | +
|---|---|
+admCredential+ + +AdmCredential_STATUS + + + |
+
+ AdmCredential: Description of a NotificationHub AdmCredential. + |
+
+apnsCredential+ + +ApnsCredential_STATUS + + + |
+
+ ApnsCredential: Description of a NotificationHub ApnsCredential. + |
+
+baiduCredential+ + +BaiduCredential_STATUS + + + |
+
+ BaiduCredential: Description of a NotificationHub BaiduCredential. + |
+
+browserCredential+ + +BrowserCredential_STATUS + + + |
+
+ BrowserCredential: Description of a NotificationHub BrowserCredential. + |
+
+gcmCredential+ + +GcmCredential_STATUS + + + |
+
+ GcmCredential: Description of a NotificationHub GcmCredential. + |
+
+mpnsCredential+ + +MpnsCredential_STATUS + + + |
+
+ MpnsCredential: Description of a NotificationHub MpnsCredential. + |
+
+wnsCredential+ + +WnsCredential_STATUS + + + |
+
+ WnsCredential: Description of a NotificationHub WnsCredential. + |
+
+xiaomiCredential+ + +XiaomiCredential_STATUS + + + |
+
+ XiaomiCredential: Description of a NotificationHub XiaomiCredential. + |
+
+(Appears on:NamespaceProperties_STATUS) +
+Represents a Private Endpoint Connection ARM resource - a sub-resource of Notification Hubs namespace.
+| Field | +Description | +
|---|---|
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. E.g. +“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” + |
+
+(Appears on:NetworkAcls) +
+A default (public Internet) network authorization rule, which contains rights if no other network rule matches.
+| Field | +Description | +
|---|---|
+rights+ + +[]AccessRights + + + |
+
+ Rights: List of access rights. + |
+
+(Appears on:NetworkAcls_STATUS) +
+A default (public Internet) network authorization rule, which contains rights if no other network rule matches.
+| Field | +Description | +
|---|---|
+rights+ + +[]AccessRights_STATUS + + + |
+
+ Rights: List of access rights. + |
+
string alias)+(Appears on:NamespaceProperties) +
+Type of public network access.
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
string alias)+(Appears on:NamespaceProperties_STATUS) +
+Type of public network access.
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
string alias)+(Appears on:NamespaceProperties) +
+Allowed replication region
+| Value | +Description | +
|---|---|
"AustraliaEast" |
++ |
"BrazilSouth" |
++ |
"Default" |
++ |
"None" |
++ |
"NorthEurope" |
++ |
"SouthAfricaNorth" |
++ |
"SouthEastAsia" |
++ |
"WestUs2" |
++ |
string alias)+(Appears on:NamespaceProperties_STATUS) +
+Allowed replication region
+| Value | +Description | +
|---|---|
"AustraliaEast" |
++ |
"BrazilSouth" |
++ |
"Default" |
++ |
"None" |
++ |
"NorthEurope" |
++ |
"SouthAfricaNorth" |
++ |
"SouthEastAsia" |
++ |
"WestUs2" |
++ |
+(Appears on:NamespacesAuthorizationRule_Spec, NotificationHubsAuthorizationRule_Spec) +
+SharedAccessAuthorizationRule properties.
+| Field | +Description | +
|---|---|
+rights+ + +[]AccessRights + + + |
+
+ Rights: Gets or sets the rights associated with the rule. + |
+
+(Appears on:NamespacesAuthorizationRule_STATUS, NotificationHubProperties_STATUS, NotificationHubsAuthorizationRule_STATUS) +
+SharedAccessAuthorizationRule properties.
+| Field | +Description | +
|---|---|
+claimType+ +string + + |
+
+ ClaimType: Gets a string that describes the claim type + |
+
+claimValue+ +string + + |
+
+ ClaimValue: Gets a string that describes the claim value + |
+
+createdTime+ +string + + |
+
+ CreatedTime: Gets the created time for this rule + |
+
+keyName+ +string + + |
+
+ KeyName: Gets a string that describes the authorization rule. + |
+
+modifiedTime+ +string + + |
+
+ ModifiedTime: Gets the last modified time for this rule + |
+
+revision+ +int + + |
+
+ Revision: Gets the revision number for the rule + |
+
+rights+ + +[]AccessRights_STATUS + + + |
+
+ Rights: Gets or sets the rights associated with the rule. + |
+
+(Appears on:Namespace_Spec, NotificationHub_Spec) +
+The Sku description for a namespace
+| Field | +Description | +
|---|---|
+capacity+ +int + + |
+
+ Capacity: Gets or sets the capacity of the resource + |
+
+family+ +string + + |
+
+ Family: Gets or sets the Sku Family + |
+
+name+ + +SkuName + + + |
+
+ Name: Namespace SKU name. + |
+
+size+ +string + + |
+
+ Size: Gets or sets the Sku size + |
+
+tier+ +string + + |
+
+ Tier: Gets or sets the tier of particular sku + |
+
string alias)+(Appears on:Sku) +
+Namespace SKU name.
+| Value | +Description | +
|---|---|
"Basic" |
++ |
"Free" |
++ |
"Standard" |
++ |
string alias)+(Appears on:Sku_STATUS) +
+Namespace SKU name.
+| Value | +Description | +
|---|---|
"Basic" |
++ |
"Free" |
++ |
"Standard" |
++ |
+(Appears on:Namespace_STATUS, NotificationHub_STATUS) +
+The Sku description for a namespace
+| Field | +Description | +
|---|---|
+capacity+ +int + + |
+
+ Capacity: Gets or sets the capacity of the resource + |
+
+family+ +string + + |
+
+ Family: Gets or sets the Sku Family + |
+
+name+ + +SkuName_STATUS + + + |
+
+ Name: Namespace SKU name. + |
+
+size+ +string + + |
+
+ Size: Gets or sets the Sku size + |
+
+tier+ +string + + |
+
+ Tier: Gets or sets the tier of particular sku + |
+
string alias)+(Appears on:SystemData_STATUS) +
+| Value | +Description | +
|---|---|
"Application" |
++ |
"Key" |
++ |
"ManagedIdentity" |
++ |
"User" |
++ |
string alias)+(Appears on:SystemData_STATUS) +
+| Value | +Description | +
|---|---|
"Application" |
++ |
"Key" |
++ |
"ManagedIdentity" |
++ |
"User" |
++ |
+(Appears on:Namespace_STATUS, NamespacesAuthorizationRule_STATUS, NotificationHub_STATUS, NotificationHubsAuthorizationRule_STATUS) +
+Metadata pertaining to creation and last modification of the resource.
+| Field | +Description | +
|---|---|
+createdAt+ +string + + |
+
+ CreatedAt: The timestamp of resource creation (UTC). + |
+
+createdBy+ +string + + |
+
+ CreatedBy: The identity that created the resource. + |
+
+createdByType+ + +SystemData_CreatedByType_STATUS + + + |
+
+ CreatedByType: The type of identity that created the resource. + |
+
+lastModifiedAt+ +string + + |
+
+ LastModifiedAt: The timestamp of resource last modification (UTC) + |
+
+lastModifiedBy+ +string + + |
+
+ LastModifiedBy: The identity that last modified the resource. + |
+
+lastModifiedByType+ + +SystemData_LastModifiedByType_STATUS + + + |
+
+ LastModifiedByType: The type of identity that last modified the resource. + |
+
+(Appears on:NotificationHubProperties, PnsCredentials) +
+Description of a NotificationHub WnsCredential.
+| Field | +Description | +
|---|---|
+properties+ + +WnsCredentialProperties + + + |
+
+ Properties: Description of a NotificationHub WnsCredential. + |
+
+(Appears on:WnsCredential) +
+Description of a NotificationHub WnsCredential.
+| Field | +Description | +
|---|---|
+certificateKey+ + +genruntime.SecretReference + + + |
+
+ CertificateKey: Ges or sets the WNS Certificate Key. + |
+
+packageSid+ + +genruntime.SecretReference + + + |
+
+ PackageSid: Gets or sets the package ID for this credential. + |
+
+secretKey+ + +genruntime.SecretReference + + + |
+
+ SecretKey: Gets or sets the secret key. + |
+
+windowsLiveEndpoint+ + +genruntime.SecretReference + + + |
+
+ WindowsLiveEndpoint: Gets or sets the Windows Live endpoint. + |
+
+wnsCertificate+ + +genruntime.SecretReference + + + |
+
+ WnsCertificate: Gets or sets the WNS Certificate. + |
+
+(Appears on:WnsCredential_STATUS) +
+Description of a NotificationHub WnsCredential.
++(Appears on:NotificationHubProperties_STATUS, PnsCredentials_STATUS) +
+Description of a NotificationHub WnsCredential.
+| Field | +Description | +
|---|---|
+properties+ + +WnsCredentialProperties_STATUS + + + |
+
+ Properties: Description of a NotificationHub WnsCredential. + |
+
+(Appears on:NotificationHubProperties, PnsCredentials) +
+Description of a NotificationHub XiaomiCredential.
+| Field | +Description | +
|---|---|
+properties+ + +XiaomiCredentialProperties + + + |
+
+ Properties: Description of a NotificationHub XiaomiCredentialProperties. + |
+
+(Appears on:XiaomiCredential) +
+Description of a NotificationHub XiaomiCredentialProperties.
+| Field | +Description | +
|---|---|
+appSecret+ + +genruntime.SecretReference + + + |
+
+ AppSecret: Gets or sets app secret. + |
+
+endpoint+ + +genruntime.SecretReference + + + |
+
+ Endpoint: Gets or sets xiaomi service endpoint. + |
+
+(Appears on:XiaomiCredential_STATUS) +
+Description of a NotificationHub XiaomiCredentialProperties.
++(Appears on:NotificationHubProperties_STATUS, PnsCredentials_STATUS) +
+Description of a NotificationHub XiaomiCredential.
+| Field | +Description | +
|---|---|
+properties+ + +XiaomiCredentialProperties_STATUS + + + |
+
+ Properties: Description of a NotificationHub XiaomiCredentialProperties. + |
+
string alias)+(Appears on:NamespaceProperties) +
+Namespace SKU name.
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
string alias)+(Appears on:NamespaceProperties_STATUS) +
+Namespace SKU name.
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
Package v1api20240101 contains API Schema definitions for the servicebus v1api20240101 API group
+string alias)| Value | +Description | +
|---|---|
"2024-01-01" |
++ |
+(Appears on:NamespacesTopicsSubscriptionsRule_Spec) +
+Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter +expression.
+| Field | +Description | +
|---|---|
+compatibilityLevel+ +int + + |
+
+ CompatibilityLevel: This property is reserved for future use. An integer value showing the compatibility level, +currently hard-coded to 20. + |
+
+requiresPreprocessing+ +bool + + |
+
+ RequiresPreprocessing: Value that indicates whether the rule action requires preprocessing. + |
+
+sqlExpression+ +string + + |
+
+ SqlExpression: SQL expression. e.g. MyProperty=‘ABC’ + |
+
+(Appears on:NamespacesTopicsSubscriptionsRule_STATUS) +
+Represents the filter actions which are allowed for the transformation of a message that have been matched by a filter +expression.
+| Field | +Description | +
|---|---|
+compatibilityLevel+ +int + + |
+
+ CompatibilityLevel: This property is reserved for future use. An integer value showing the compatibility level, +currently hard-coded to 20. + |
+
+requiresPreprocessing+ +bool + + |
+
+ RequiresPreprocessing: Value that indicates whether the rule action requires preprocessing. + |
+
+sqlExpression+ +string + + |
+
+ SqlExpression: SQL expression. e.g. MyProperty=‘ABC’ + |
+
+(Appears on:NamespacesTopicsSubscriptionsRule_Spec) +
+Represents the correlation filter expression.
+| Field | +Description | +
|---|---|
+contentType+ +string + + |
+
+ ContentType: Content type of the message. + |
+
+correlationId+ +string + + |
+
+ CorrelationId: Identifier of the correlation. + |
+
+label+ +string + + |
+
+ Label: Application specific label. + |
+
+messageId+ +string + + |
+
+ MessageId: Identifier of the message. + |
+
+properties+ +map[string]string + + |
+
+ Properties: dictionary object for custom filters + |
+
+replyTo+ +string + + |
+
+ ReplyTo: Address of the queue to reply to. + |
+
+replyToSessionId+ +string + + |
+
+ ReplyToSessionId: Session identifier to reply to. + |
+
+requiresPreprocessing+ +bool + + |
+
+ RequiresPreprocessing: Value that indicates whether the rule action requires preprocessing. + |
+
+sessionId+ +string + + |
+
+ SessionId: Session identifier. + |
+
+to+ +string + + |
+
+ To: Address to send to. + |
+
+(Appears on:NamespacesTopicsSubscriptionsRule_STATUS) +
+Represents the correlation filter expression.
+| Field | +Description | +
|---|---|
+contentType+ +string + + |
+
+ ContentType: Content type of the message. + |
+
+correlationId+ +string + + |
+
+ CorrelationId: Identifier of the correlation. + |
+
+label+ +string + + |
+
+ Label: Application specific label. + |
+
+messageId+ +string + + |
+
+ MessageId: Identifier of the message. + |
+
+properties+ +map[string]string + + |
+
+ Properties: dictionary object for custom filters + |
+
+replyTo+ +string + + |
+
+ ReplyTo: Address of the queue to reply to. + |
+
+replyToSessionId+ +string + + |
+
+ ReplyToSessionId: Session identifier to reply to. + |
+
+requiresPreprocessing+ +bool + + |
+
+ RequiresPreprocessing: Value that indicates whether the rule action requires preprocessing. + |
+
+sessionId+ +string + + |
+
+ SessionId: Session identifier. + |
+
+to+ +string + + |
+
+ To: Address to send to. + |
+
+(Appears on:Namespace_Spec) +
+Properties to configure Encryption
+| Field | +Description | +
|---|---|
+keySource+ + +Encryption_KeySource + + + |
+
+ KeySource: Enumerates the possible value of keySource for Encryption + |
+
+keyVaultProperties+ + +[]KeyVaultProperties + + + |
+
+ KeyVaultProperties: Properties of KeyVault + |
+
+requireInfrastructureEncryption+ +bool + + |
+
+ RequireInfrastructureEncryption: Enable Infrastructure Encryption (Double Encryption) + |
+
string alias)+(Appears on:Encryption) +
+| Value | +Description | +
|---|---|
"Microsoft.KeyVault" |
++ |
string alias)+(Appears on:Encryption_STATUS) +
+| Value | +Description | +
|---|---|
"Microsoft.KeyVault" |
++ |
+(Appears on:Namespace_STATUS) +
+Properties to configure Encryption
+| Field | +Description | +
|---|---|
+keySource+ + +Encryption_KeySource_STATUS + + + |
+
+ KeySource: Enumerates the possible value of keySource for Encryption + |
+
+keyVaultProperties+ + +[]KeyVaultProperties_STATUS + + + |
+
+ KeyVaultProperties: Properties of KeyVault + |
+
+requireInfrastructureEncryption+ +bool + + |
+
+ RequireInfrastructureEncryption: Enable Infrastructure Encryption (Double Encryption) + |
+
string alias)+(Appears on:NamespacesQueue_STATUS, NamespacesTopic_STATUS, NamespacesTopicsSubscription_STATUS) +
+Entity status.
+| Value | +Description | +
|---|---|
"Active" |
++ |
"Creating" |
++ |
"Deleting" |
++ |
"Disabled" |
++ |
"ReceiveDisabled" |
++ |
"Renaming" |
++ |
"Restoring" |
++ |
"SendDisabled" |
++ |
"Unknown" |
++ |
string alias)+(Appears on:NamespacesTopicsSubscriptionsRule_Spec) +
+Rule filter types
+| Value | +Description | +
|---|---|
"CorrelationFilter" |
++ |
"SqlFilter" |
++ |
string alias)+(Appears on:NamespacesTopicsSubscriptionsRule_STATUS) +
+Rule filter types
+| Value | +Description | +
|---|---|
"CorrelationFilter" |
++ |
"SqlFilter" |
++ |
+(Appears on:Namespace_Spec) +
+Properties to configure User Assigned Identities for Bring your Own Keys
+| Field | +Description | +
|---|---|
+type+ + +Identity_Type + + + |
+
+ Type: Type of managed service identity. + |
+
+userAssignedIdentities+ + +[]UserAssignedIdentityDetails + + + |
+
+ UserAssignedIdentities: Properties for User Assigned Identities + |
+
+(Appears on:Namespace_STATUS) +
+Properties to configure User Assigned Identities for Bring your Own Keys
+| Field | +Description | +
|---|---|
+principalId+ +string + + |
+
+ PrincipalId: ObjectId from the KeyVault + |
+
+tenantId+ +string + + |
+
+ TenantId: TenantId from the KeyVault + |
+
+type+ + +Identity_Type_STATUS + + + |
+
+ Type: Type of managed service identity. + |
+
+userAssignedIdentities+ + +map[string]./api/servicebus/v1api20240101.UserAssignedIdentity_STATUS + + + |
+
+ UserAssignedIdentities: Properties for User Assigned Identities + |
+
string alias)+(Appears on:Identity) +
+| Value | +Description | +
|---|---|
"None" |
++ |
"SystemAssigned" |
++ |
"SystemAssigned, UserAssigned" |
++ |
"UserAssigned" |
++ |
string alias)+(Appears on:Identity_STATUS) +
+| Value | +Description | +
|---|---|
"None" |
++ |
"SystemAssigned" |
++ |
"SystemAssigned, UserAssigned" |
++ |
"UserAssigned" |
++ |
+(Appears on:Encryption) +
+Properties to configure keyVault Properties
+| Field | +Description | +
|---|---|
+identity+ + +UserAssignedIdentityProperties + + + |
++ | +
+keyName+ +string + + |
+
+ KeyName: Name of the Key from KeyVault + |
+
+keyVaultUri+ +string + + |
+
+ KeyVaultUri: Uri of KeyVault + |
+
+keyVersion+ +string + + |
+
+ KeyVersion: Version of KeyVault + |
+
+(Appears on:Encryption_STATUS) +
+Properties to configure keyVault Properties
+| Field | +Description | +
|---|---|
+identity+ + +UserAssignedIdentityProperties_STATUS + + + |
++ | +
+keyName+ +string + + |
+
+ KeyName: Name of the Key from KeyVault + |
+
+keyVaultUri+ +string + + |
+
+ KeyVaultUri: Uri of KeyVault + |
+
+keyVersion+ +string + + |
+
+ KeyVersion: Version of KeyVault + |
+
+(Appears on:NamespacesQueue_STATUS, NamespacesTopic_STATUS, NamespacesTopicsSubscription_STATUS) +
+Message Count Details.
+| Field | +Description | +
|---|---|
+activeMessageCount+ +int + + |
+
+ ActiveMessageCount: Number of active messages in the queue, topic, or subscription. + |
+
+deadLetterMessageCount+ +int + + |
+
+ DeadLetterMessageCount: Number of messages that are dead lettered. + |
+
+scheduledMessageCount+ +int + + |
+
+ ScheduledMessageCount: Number of scheduled messages. + |
+
+transferDeadLetterMessageCount+ +int + + |
+
+ TransferDeadLetterMessageCount: Number of messages transferred into dead letters. + |
+
+transferMessageCount+ +int + + |
+
+ TransferMessageCount: Number of messages transferred to another queue, topic, or subscription. + |
+
Generator information: +- Generated from: /servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/namespace-preview.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName} +
| Field | +Description | +||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||||||||||
+spec+ + +Namespace_Spec + + + |
+
+ + +
|
+||||||||||||||||||||||||||||
+status+ + +Namespace_STATUS + + + |
++ | +
+(Appears on:NamespaceOperatorSpec) +
+| Field | +Description | +
|---|---|
+endpoint+ + +genruntime.SecretDestination + + + |
+
+ Endpoint: indicates where the Endpoint secret should be placed. If omitted, the secret will not be retrieved from Azure. + |
+
+primaryConnectionString+ + +genruntime.SecretDestination + + + |
+
+ PrimaryConnectionString: indicates where the PrimaryConnectionString secret should be placed. If omitted, the secret +will not be retrieved from Azure. + |
+
+primaryKey+ + +genruntime.SecretDestination + + + |
+
+ PrimaryKey: indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from +Azure. + |
+
+secondaryConnectionString+ + +genruntime.SecretDestination + + + |
+
+ SecondaryConnectionString: indicates where the SecondaryConnectionString secret should be placed. If omitted, the secret +will not be retrieved from Azure. + |
+
+secondaryKey+ + +genruntime.SecretDestination + + + |
+
+ SecondaryKey: indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved +from Azure. + |
+
+(Appears on:Namespace_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+secrets+ + +NamespaceOperatorSecrets + + + |
+
+ Secrets: configures where to place Azure generated secrets. + |
+
+(Appears on:Namespace) +
+| Field | +Description | +
|---|---|
+alternateName+ +string + + |
+
+ AlternateName: Alternate name for namespace + |
+
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+createdAt+ +string + + |
+
+ CreatedAt: The time the namespace was created + |
+
+disableLocalAuth+ +bool + + |
+
+ DisableLocalAuth: This property disables SAS authentication for the Service Bus namespace. + |
+
+encryption+ + +Encryption_STATUS + + + |
+
+ Encryption: Properties of BYOK Encryption description + |
+
+id+ +string + + |
+
+ Id: Resource Id + |
+
+identity+ + +Identity_STATUS + + + |
+
+ Identity: Properties of BYOK Identity description + |
+
+location+ +string + + |
+
+ Location: The Geo-location where the resource lives + |
+
+metricId+ +string + + |
+
+ MetricId: Identifier for Azure Insights metrics + |
+
+minimumTlsVersion+ + +SBNamespaceProperties_MinimumTlsVersion_STATUS + + + |
+
+ MinimumTlsVersion: The minimum TLS version for the cluster to support, e.g. ‘1.2’ + |
+
+name+ +string + + |
+
+ Name: Resource name + |
+
+premiumMessagingPartitions+ +int + + |
+
+ PremiumMessagingPartitions: The number of partitions of a Service Bus namespace. This property is only applicable to +Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4 + |
+
+privateEndpointConnections+ + +[]PrivateEndpointConnection_STATUS + + + |
+
+ PrivateEndpointConnections: List of private endpoint connections. + |
+
+provisioningState+ +string + + |
+
+ ProvisioningState: Provisioning state of the namespace. + |
+
+publicNetworkAccess+ + +SBNamespaceProperties_PublicNetworkAccess_STATUS + + + |
+
+ PublicNetworkAccess: This determines if traffic is allowed over public network. By default it is enabled. + |
+
+serviceBusEndpoint+ +string + + |
+
+ ServiceBusEndpoint: Endpoint you can use to perform Service Bus operations. + |
+
+sku+ + +SBSku_STATUS + + + |
+
+ Sku: Properties of SKU + |
+
+status+ +string + + |
+
+ Status: Status of the namespace. + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: The system meta data relating to this resource. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags + |
+
+type+ +string + + |
+
+ Type: Resource type + |
+
+updatedAt+ +string + + |
+
+ UpdatedAt: The time the namespace was updated. + |
+
+zoneRedundant+ +bool + + |
+
+ ZoneRedundant: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. + |
+
+(Appears on:Namespace) +
+| Field | +Description | +
|---|---|
+alternateName+ +string + + |
+
+ AlternateName: Alternate name for namespace + |
+
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+disableLocalAuth+ +bool + + |
+
+ DisableLocalAuth: This property disables SAS authentication for the Service Bus namespace. + |
+
+encryption+ + +Encryption + + + |
+
+ Encryption: Properties of BYOK Encryption description + |
+
+identity+ + +Identity + + + |
+
+ Identity: Properties of BYOK Identity description + |
+
+location+ +string + + |
+
+ Location: The Geo-location where the resource lives + |
+
+minimumTlsVersion+ + +SBNamespaceProperties_MinimumTlsVersion + + + |
+
+ MinimumTlsVersion: The minimum TLS version for the cluster to support, e.g. ‘1.2’ + |
+
+operatorSpec+ + +NamespaceOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a resources.azure.com/ResourceGroup resource + |
+
+premiumMessagingPartitions+ +int + + |
+
+ PremiumMessagingPartitions: The number of partitions of a Service Bus namespace. This property is only applicable to +Premium SKU namespaces. The default value is 1 and possible values are 1, 2 and 4 + |
+
+publicNetworkAccess+ + +SBNamespaceProperties_PublicNetworkAccess + + + |
+
+ PublicNetworkAccess: This determines if traffic is allowed over public network. By default it is enabled. + |
+
+sku+ + +SBSku + + + |
+
+ Sku: Properties of SKU + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags + |
+
+zoneRedundant+ +bool + + |
+
+ ZoneRedundant: Enabling this property creates a Premium Service Bus Namespace in regions supported availability zones. + |
+
Generator information: +- Generated from: /servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/AuthorizationRules.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/AuthorizationRules/{authorizationRuleName} +
| Field | +Description | +||||||||
|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||
+spec+ + +NamespacesAuthorizationRule_Spec + + + |
+
+ + +
|
+||||||||
+status+ + +NamespacesAuthorizationRule_STATUS + + + |
++ | +
+(Appears on:NamespacesAuthorizationRuleOperatorSpec) +
+| Field | +Description | +
|---|---|
+primaryConnectionString+ + +genruntime.SecretDestination + + + |
+
+ PrimaryConnectionString: indicates where the PrimaryConnectionString secret should be placed. If omitted, the secret +will not be retrieved from Azure. + |
+
+primaryKey+ + +genruntime.SecretDestination + + + |
+
+ PrimaryKey: indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from +Azure. + |
+
+secondaryConnectionString+ + +genruntime.SecretDestination + + + |
+
+ SecondaryConnectionString: indicates where the SecondaryConnectionString secret should be placed. If omitted, the secret +will not be retrieved from Azure. + |
+
+secondaryKey+ + +genruntime.SecretDestination + + + |
+
+ SecondaryKey: indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved +from Azure. + |
+
+(Appears on:NamespacesAuthorizationRule_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+secrets+ + +NamespacesAuthorizationRuleOperatorSecrets + + + |
+
+ Secrets: configures where to place Azure generated secrets. + |
+
+(Appears on:NamespacesAuthorizationRule) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+rights+ + +[]Namespaces_AuthorizationRule_Properties_Rights_STATUS + + + |
+
+ Rights: The rights associated with the rule. + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: The system meta data relating to this resource. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” + |
+
+(Appears on:NamespacesAuthorizationRule) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+operatorSpec+ + +NamespacesAuthorizationRuleOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a servicebus.azure.com/Namespace resource + |
+
+rights+ + +[]Namespaces_AuthorizationRule_Properties_Rights_Spec + + + |
+
+ Rights: The rights associated with the rule. + |
+
Generator information: +- Generated from: /servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/Queue.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/queues/{queueName} +
| Field | +Description | +||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||||||||||||||||||
+spec+ + +NamespacesQueue_Spec + + + |
+
+ + +
|
+||||||||||||||||||||||||||||||||||||
+status+ + +NamespacesQueue_STATUS + + + |
++ | +
+(Appears on:NamespacesQueue_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:NamespacesQueue) +
+| Field | +Description | +
|---|---|
+accessedAt+ +string + + |
+
+ AccessedAt: Last time a message was sent, or the last time there was a receive request to this queue. + |
+
+autoDeleteOnIdle+ +string + + |
+
+ AutoDeleteOnIdle: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration +is 5 minutes. + |
+
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+countDetails+ + +MessageCountDetails_STATUS + + + |
+
+ CountDetails: Message Count Details. + |
+
+createdAt+ +string + + |
+
+ CreatedAt: The exact time the message was created. + |
+
+deadLetteringOnMessageExpiration+ +bool + + |
+
+ DeadLetteringOnMessageExpiration: A value that indicates whether this queue has dead letter support when a message +expires. + |
+
+defaultMessageTimeToLive+ +string + + |
+
+ DefaultMessageTimeToLive: ISO 8601 default message timespan to live value. This is the duration after which the message +expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not +set on a message itself. + |
+
+duplicateDetectionHistoryTimeWindow+ +string + + |
+
+ DuplicateDetectionHistoryTimeWindow: ISO 8601 timeSpan structure that defines the duration of the duplicate detection +history. The default value is 10 minutes. + |
+
+enableBatchedOperations+ +bool + + |
+
+ EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled. + |
+
+enableExpress+ +bool + + |
+
+ EnableExpress: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory +temporarily before writing it to persistent storage. + |
+
+enablePartitioning+ +bool + + |
+
+ EnablePartitioning: A value that indicates whether the queue is to be partitioned across multiple message brokers. + |
+
+forwardDeadLetteredMessagesTo+ +string + + |
+
+ ForwardDeadLetteredMessagesTo: Queue/Topic name to forward the Dead Letter message + |
+
+forwardTo+ +string + + |
+
+ ForwardTo: Queue/Topic name to forward the messages + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+lockDuration+ +string + + |
+
+ LockDuration: ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for +other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute. + |
+
+maxDeliveryCount+ +int + + |
+
+ MaxDeliveryCount: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. +default value is 10. + |
+
+maxMessageSizeInKilobytes+ +int + + |
+
+ MaxMessageSizeInKilobytes: Maximum size (in KB) of the message payload that can be accepted by the queue. This property +is only used in Premium today and default is 1024. + |
+
+maxSizeInMegabytes+ +int + + |
+
+ MaxSizeInMegabytes: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. +Default is 1024. + |
+
+messageCount+ +int + + |
+
+ MessageCount: The number of messages in the queue. + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+requiresDuplicateDetection+ +bool + + |
+
+ RequiresDuplicateDetection: A value indicating if this queue requires duplicate detection. + |
+
+requiresSession+ +bool + + |
+
+ RequiresSession: A value that indicates whether the queue supports the concept of sessions. + |
+
+sizeInBytes+ +int + + |
+
+ SizeInBytes: The size of the queue, in bytes. + |
+
+status+ + +EntityStatus_STATUS + + + |
+
+ Status: Enumerates the possible values for the status of a messaging entity. + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: The system meta data relating to this resource. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” + |
+
+updatedAt+ +string + + |
+
+ UpdatedAt: The exact time the message was updated. + |
+
+(Appears on:NamespacesQueue) +
+| Field | +Description | +
|---|---|
+autoDeleteOnIdle+ +string + + |
+
+ AutoDeleteOnIdle: ISO 8061 timeSpan idle interval after which the queue is automatically deleted. The minimum duration +is 5 minutes. + |
+
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+deadLetteringOnMessageExpiration+ +bool + + |
+
+ DeadLetteringOnMessageExpiration: A value that indicates whether this queue has dead letter support when a message +expires. + |
+
+defaultMessageTimeToLive+ +string + + |
+
+ DefaultMessageTimeToLive: ISO 8601 default message timespan to live value. This is the duration after which the message +expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not +set on a message itself. + |
+
+duplicateDetectionHistoryTimeWindow+ +string + + |
+
+ DuplicateDetectionHistoryTimeWindow: ISO 8601 timeSpan structure that defines the duration of the duplicate detection +history. The default value is 10 minutes. + |
+
+enableBatchedOperations+ +bool + + |
+
+ EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled. + |
+
+enableExpress+ +bool + + |
+
+ EnableExpress: A value that indicates whether Express Entities are enabled. An express queue holds a message in memory +temporarily before writing it to persistent storage. + |
+
+enablePartitioning+ +bool + + |
+
+ EnablePartitioning: A value that indicates whether the queue is to be partitioned across multiple message brokers. + |
+
+forwardDeadLetteredMessagesTo+ +string + + |
+
+ ForwardDeadLetteredMessagesTo: Queue/Topic name to forward the Dead Letter message + |
+
+forwardTo+ +string + + |
+
+ ForwardTo: Queue/Topic name to forward the messages + |
+
+lockDuration+ +string + + |
+
+ LockDuration: ISO 8601 timespan duration of a peek-lock; that is, the amount of time that the message is locked for +other receivers. The maximum value for LockDuration is 5 minutes; the default value is 1 minute. + |
+
+maxDeliveryCount+ +int + + |
+
+ MaxDeliveryCount: The maximum delivery count. A message is automatically deadlettered after this number of deliveries. +default value is 10. + |
+
+maxMessageSizeInKilobytes+ +int + + |
+
+ MaxMessageSizeInKilobytes: Maximum size (in KB) of the message payload that can be accepted by the queue. This property +is only used in Premium today and default is 1024. + |
+
+maxSizeInMegabytes+ +int + + |
+
+ MaxSizeInMegabytes: The maximum size of the queue in megabytes, which is the size of memory allocated for the queue. +Default is 1024. + |
+
+operatorSpec+ + +NamespacesQueueOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a servicebus.azure.com/Namespace resource + |
+
+requiresDuplicateDetection+ +bool + + |
+
+ RequiresDuplicateDetection: A value indicating if this queue requires duplicate detection. + |
+
+requiresSession+ +bool + + |
+
+ RequiresSession: A value that indicates whether the queue supports the concept of sessions. + |
+
Generator information: +- Generated from: /servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/topics.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName} +
| Field | +Description | +||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||||||||
+spec+ + +NamespacesTopic_Spec + + + |
+
+ + +
|
+||||||||||||||||||||||||||
+status+ + +NamespacesTopic_STATUS + + + |
++ | +
+(Appears on:NamespacesTopic_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:NamespacesTopic) +
+| Field | +Description | +
|---|---|
+accessedAt+ +string + + |
+
+ AccessedAt: Last time the message was sent, or a request was received, for this topic. + |
+
+autoDeleteOnIdle+ +string + + |
+
+ AutoDeleteOnIdle: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration +is 5 minutes. + |
+
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+countDetails+ + +MessageCountDetails_STATUS + + + |
+
+ CountDetails: Message count details + |
+
+createdAt+ +string + + |
+
+ CreatedAt: Exact time the message was created. + |
+
+defaultMessageTimeToLive+ +string + + |
+
+ DefaultMessageTimeToLive: ISO 8601 Default message timespan to live value. This is the duration after which the message +expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not +set on a message itself. + |
+
+duplicateDetectionHistoryTimeWindow+ +string + + |
+
+ DuplicateDetectionHistoryTimeWindow: ISO8601 timespan structure that defines the duration of the duplicate detection +history. The default value is 10 minutes. + |
+
+enableBatchedOperations+ +bool + + |
+
+ EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled. + |
+
+enableExpress+ +bool + + |
+
+ EnableExpress: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory +temporarily before writing it to persistent storage. + |
+
+enablePartitioning+ +bool + + |
+
+ EnablePartitioning: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+maxMessageSizeInKilobytes+ +int + + |
+
+ MaxMessageSizeInKilobytes: Maximum size (in KB) of the message payload that can be accepted by the topic. This property +is only used in Premium today and default is 1024. + |
+
+maxSizeInMegabytes+ +int + + |
+
+ MaxSizeInMegabytes: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. +Default is 1024. + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+requiresDuplicateDetection+ +bool + + |
+
+ RequiresDuplicateDetection: Value indicating if this topic requires duplicate detection. + |
+
+sizeInBytes+ +int + + |
+
+ SizeInBytes: Size of the topic, in bytes. + |
+
+status+ + +EntityStatus_STATUS + + + |
+
+ Status: Enumerates the possible values for the status of a messaging entity. + |
+
+subscriptionCount+ +int + + |
+
+ SubscriptionCount: Number of subscriptions. + |
+
+supportOrdering+ +bool + + |
+
+ SupportOrdering: Value that indicates whether the topic supports ordering. + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: The system meta data relating to this resource. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” + |
+
+updatedAt+ +string + + |
+
+ UpdatedAt: The exact time the message was updated. + |
+
+(Appears on:NamespacesTopic) +
+| Field | +Description | +
|---|---|
+autoDeleteOnIdle+ +string + + |
+
+ AutoDeleteOnIdle: ISO 8601 timespan idle interval after which the topic is automatically deleted. The minimum duration +is 5 minutes. + |
+
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+defaultMessageTimeToLive+ +string + + |
+
+ DefaultMessageTimeToLive: ISO 8601 Default message timespan to live value. This is the duration after which the message +expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not +set on a message itself. + |
+
+duplicateDetectionHistoryTimeWindow+ +string + + |
+
+ DuplicateDetectionHistoryTimeWindow: ISO8601 timespan structure that defines the duration of the duplicate detection +history. The default value is 10 minutes. + |
+
+enableBatchedOperations+ +bool + + |
+
+ EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled. + |
+
+enableExpress+ +bool + + |
+
+ EnableExpress: Value that indicates whether Express Entities are enabled. An express topic holds a message in memory +temporarily before writing it to persistent storage. + |
+
+enablePartitioning+ +bool + + |
+
+ EnablePartitioning: Value that indicates whether the topic to be partitioned across multiple message brokers is enabled. + |
+
+maxMessageSizeInKilobytes+ +int + + |
+
+ MaxMessageSizeInKilobytes: Maximum size (in KB) of the message payload that can be accepted by the topic. This property +is only used in Premium today and default is 1024. + |
+
+maxSizeInMegabytes+ +int + + |
+
+ MaxSizeInMegabytes: Maximum size of the topic in megabytes, which is the size of the memory allocated for the topic. +Default is 1024. + |
+
+operatorSpec+ + +NamespacesTopicOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a servicebus.azure.com/Namespace resource + |
+
+requiresDuplicateDetection+ +bool + + |
+
+ RequiresDuplicateDetection: Value indicating if this topic requires duplicate detection. + |
+
+supportOrdering+ +bool + + |
+
+ SupportOrdering: Value that indicates whether the topic supports ordering. + |
+
Generator information: +- Generated from: /servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/subscriptions.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName} +
| Field | +Description | +||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||||||||||||||
+spec+ + +NamespacesTopicsSubscription_Spec + + + |
+
+ + +
|
+||||||||||||||||||||||||||||||||
+status+ + +NamespacesTopicsSubscription_STATUS + + + |
++ | +
+(Appears on:NamespacesTopicsSubscription_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:NamespacesTopicsSubscription) +
+| Field | +Description | +
|---|---|
+accessedAt+ +string + + |
+
+ AccessedAt: Last time there was a receive request to this subscription. + |
+
+autoDeleteOnIdle+ +string + + |
+
+ AutoDeleteOnIdle: ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration +is 5 minutes. + |
+
+clientAffineProperties+ + +SBClientAffineProperties_STATUS + + + |
+
+ ClientAffineProperties: Properties specific to client affine subscriptions. + |
+
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+countDetails+ + +MessageCountDetails_STATUS + + + |
+
+ CountDetails: Message count details + |
+
+createdAt+ +string + + |
+
+ CreatedAt: Exact time the message was created. + |
+
+deadLetteringOnFilterEvaluationExceptions+ +bool + + |
+
+ DeadLetteringOnFilterEvaluationExceptions: Value that indicates whether a subscription has dead letter support on filter +evaluation exceptions. + |
+
+deadLetteringOnMessageExpiration+ +bool + + |
+
+ DeadLetteringOnMessageExpiration: Value that indicates whether a subscription has dead letter support when a message +expires. + |
+
+defaultMessageTimeToLive+ +string + + |
+
+ DefaultMessageTimeToLive: ISO 8061 Default message timespan to live value. This is the duration after which the message +expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not +set on a message itself. + |
+
+duplicateDetectionHistoryTimeWindow+ +string + + |
+
+ DuplicateDetectionHistoryTimeWindow: ISO 8601 timeSpan structure that defines the duration of the duplicate detection +history. The default value is 10 minutes. + |
+
+enableBatchedOperations+ +bool + + |
+
+ EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled. + |
+
+forwardDeadLetteredMessagesTo+ +string + + |
+
+ ForwardDeadLetteredMessagesTo: Queue/Topic name to forward the Dead Letter message + |
+
+forwardTo+ +string + + |
+
+ ForwardTo: Queue/Topic name to forward the messages + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} + |
+
+isClientAffine+ +bool + + |
+
+ IsClientAffine: Value that indicates whether the subscription has an affinity to the client id. + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+lockDuration+ +string + + |
+
+ LockDuration: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute. + |
+
+maxDeliveryCount+ +int + + |
+
+ MaxDeliveryCount: Number of maximum deliveries. + |
+
+messageCount+ +int + + |
+
+ MessageCount: Number of messages. + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+requiresSession+ +bool + + |
+
+ RequiresSession: Value indicating if a subscription supports the concept of sessions. + |
+
+status+ + +EntityStatus_STATUS + + + |
+
+ Status: Enumerates the possible values for the status of a messaging entity. + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: The system meta data relating to this resource. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” + |
+
+updatedAt+ +string + + |
+
+ UpdatedAt: The exact time the message was updated. + |
+
+(Appears on:NamespacesTopicsSubscription) +
+| Field | +Description | +
|---|---|
+autoDeleteOnIdle+ +string + + |
+
+ AutoDeleteOnIdle: ISO 8061 timeSpan idle interval after which the topic is automatically deleted. The minimum duration +is 5 minutes. + |
+
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+clientAffineProperties+ + +SBClientAffineProperties + + + |
+
+ ClientAffineProperties: Properties specific to client affine subscriptions. + |
+
+deadLetteringOnFilterEvaluationExceptions+ +bool + + |
+
+ DeadLetteringOnFilterEvaluationExceptions: Value that indicates whether a subscription has dead letter support on filter +evaluation exceptions. + |
+
+deadLetteringOnMessageExpiration+ +bool + + |
+
+ DeadLetteringOnMessageExpiration: Value that indicates whether a subscription has dead letter support when a message +expires. + |
+
+defaultMessageTimeToLive+ +string + + |
+
+ DefaultMessageTimeToLive: ISO 8061 Default message timespan to live value. This is the duration after which the message +expires, starting from when the message is sent to Service Bus. This is the default value used when TimeToLive is not +set on a message itself. + |
+
+duplicateDetectionHistoryTimeWindow+ +string + + |
+
+ DuplicateDetectionHistoryTimeWindow: ISO 8601 timeSpan structure that defines the duration of the duplicate detection +history. The default value is 10 minutes. + |
+
+enableBatchedOperations+ +bool + + |
+
+ EnableBatchedOperations: Value that indicates whether server-side batched operations are enabled. + |
+
+forwardDeadLetteredMessagesTo+ +string + + |
+
+ ForwardDeadLetteredMessagesTo: Queue/Topic name to forward the Dead Letter message + |
+
+forwardTo+ +string + + |
+
+ ForwardTo: Queue/Topic name to forward the messages + |
+
+isClientAffine+ +bool + + |
+
+ IsClientAffine: Value that indicates whether the subscription has an affinity to the client id. + |
+
+lockDuration+ +string + + |
+
+ LockDuration: ISO 8061 lock duration timespan for the subscription. The default value is 1 minute. + |
+
+maxDeliveryCount+ +int + + |
+
+ MaxDeliveryCount: Number of maximum deliveries. + |
+
+operatorSpec+ + +NamespacesTopicsSubscriptionOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a servicebus.azure.com/NamespacesTopic resource + |
+
+requiresSession+ +bool + + |
+
+ RequiresSession: Value indicating if a subscription supports the concept of sessions. + |
+
Generator information: +- Generated from: /servicebus/resource-manager/Microsoft.ServiceBus/stable/2024-01-01/Rules.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}/rules/{ruleName} +
| Field | +Description | +||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||
+spec+ + +NamespacesTopicsSubscriptionsRule_Spec + + + |
+
+ + +
|
+||||||||||||||
+status+ + +NamespacesTopicsSubscriptionsRule_STATUS + + + |
++ | +
+(Appears on:NamespacesTopicsSubscriptionsRule_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:NamespacesTopicsSubscriptionsRule) +
+| Field | +Description | +
|---|---|
+action+ + +Action_STATUS + + + |
+
+ Action: Represents the filter actions which are allowed for the transformation of a message that have been matched by a +filter expression. + |
+
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+correlationFilter+ + +CorrelationFilter_STATUS + + + |
+
+ CorrelationFilter: Properties of correlationFilter + |
+
+filterType+ + +FilterType_STATUS + + + |
+
+ FilterType: Filter type that is evaluated against a BrokeredMessage. + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+sqlFilter+ + +SqlFilter_STATUS + + + |
+
+ SqlFilter: Properties of sqlFilter + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: The system meta data relating to this resource. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. E.g. “Microsoft.EventHub/Namespaces” or “Microsoft.EventHub/Namespaces/EventHubs” + |
+
+(Appears on:NamespacesTopicsSubscriptionsRule) +
+| Field | +Description | +
|---|---|
+action+ + +Action + + + |
+
+ Action: Represents the filter actions which are allowed for the transformation of a message that have been matched by a +filter expression. + |
+
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+correlationFilter+ + +CorrelationFilter + + + |
+
+ CorrelationFilter: Properties of correlationFilter + |
+
+filterType+ + +FilterType + + + |
+
+ FilterType: Filter type that is evaluated against a BrokeredMessage. + |
+
+operatorSpec+ + +NamespacesTopicsSubscriptionsRuleOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a servicebus.azure.com/NamespacesTopicsSubscription resource + |
+
+sqlFilter+ + +SqlFilter + + + |
+
+ SqlFilter: Properties of sqlFilter + |
+
string alias)+(Appears on:NamespacesAuthorizationRule_STATUS) +
+| Value | +Description | +
|---|---|
"Listen" |
++ |
"Manage" |
++ |
"Send" |
++ |
string alias)+(Appears on:NamespacesAuthorizationRule_Spec) +
+| Value | +Description | +
|---|---|
"Listen" |
++ |
"Manage" |
++ |
"Send" |
++ |
+(Appears on:Namespace_STATUS) +
+Properties of the PrivateEndpointConnection.
+| Field | +Description | +
|---|---|
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} + |
+
+(Appears on:NamespacesTopicsSubscription_Spec) +
+Properties specific to client affine subscriptions.
+| Field | +Description | +
|---|---|
+clientId+ +string + + |
+
+ ClientId: Indicates the Client ID of the application that created the client-affine subscription. + |
+
+isDurable+ +bool + + |
+
+ IsDurable: For client-affine subscriptions, this value indicates whether the subscription is durable or not. + |
+
+isShared+ +bool + + |
+
+ IsShared: For client-affine subscriptions, this value indicates whether the subscription is shared or not. + |
+
+(Appears on:NamespacesTopicsSubscription_STATUS) +
+Properties specific to client affine subscriptions.
+| Field | +Description | +
|---|---|
+clientId+ +string + + |
+
+ ClientId: Indicates the Client ID of the application that created the client-affine subscription. + |
+
+isDurable+ +bool + + |
+
+ IsDurable: For client-affine subscriptions, this value indicates whether the subscription is durable or not. + |
+
+isShared+ +bool + + |
+
+ IsShared: For client-affine subscriptions, this value indicates whether the subscription is shared or not. + |
+
string alias)+(Appears on:Namespace_Spec) +
+| Value | +Description | +
|---|---|
"1.0" |
++ |
"1.1" |
++ |
"1.2" |
++ |
string alias)+(Appears on:Namespace_STATUS) +
+| Value | +Description | +
|---|---|
"1.0" |
++ |
"1.1" |
++ |
"1.2" |
++ |
string alias)+(Appears on:Namespace_Spec) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
"SecuredByPerimeter" |
++ |
string alias)+(Appears on:Namespace_STATUS) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
"SecuredByPerimeter" |
++ |
+(Appears on:Namespace_Spec) +
+SKU of the namespace.
+| Field | +Description | +
|---|---|
+capacity+ +int + + |
+
+ Capacity: Messaging units for your service bus premium namespace. Valid capacities are {1, 2, 4, 8, 16} multiples of +your properties.premiumMessagingPartitions setting. For example, If properties.premiumMessagingPartitions is 1 then +possible capacity values are 1, 2, 4, 8, and 16. If properties.premiumMessagingPartitions is 4 then possible capacity +values are 4, 8, 16, 32 and 64 + |
+
+name+ + +SBSku_Name + + + |
+
+ Name: Name of this SKU. + |
+
+tier+ + +SBSku_Tier + + + |
+
+ Tier: The billing tier of this particular SKU. + |
+
string alias)+(Appears on:SBSku) +
+| Value | +Description | +
|---|---|
"Basic" |
++ |
"Premium" |
++ |
"Standard" |
++ |
string alias)+(Appears on:SBSku_STATUS) +
+| Value | +Description | +
|---|---|
"Basic" |
++ |
"Premium" |
++ |
"Standard" |
++ |
+(Appears on:Namespace_STATUS) +
+SKU of the namespace.
+| Field | +Description | +
|---|---|
+capacity+ +int + + |
+
+ Capacity: Messaging units for your service bus premium namespace. Valid capacities are {1, 2, 4, 8, 16} multiples of +your properties.premiumMessagingPartitions setting. For example, If properties.premiumMessagingPartitions is 1 then +possible capacity values are 1, 2, 4, 8, and 16. If properties.premiumMessagingPartitions is 4 then possible capacity +values are 4, 8, 16, 32 and 64 + |
+
+name+ + +SBSku_Name_STATUS + + + |
+
+ Name: Name of this SKU. + |
+
+tier+ + +SBSku_Tier_STATUS + + + |
+
+ Tier: The billing tier of this particular SKU. + |
+
string alias)+(Appears on:SBSku) +
+| Value | +Description | +
|---|---|
"Basic" |
++ |
"Premium" |
++ |
"Standard" |
++ |
string alias)+(Appears on:SBSku_STATUS) +
+| Value | +Description | +
|---|---|
"Basic" |
++ |
"Premium" |
++ |
"Standard" |
++ |
+(Appears on:NamespacesTopicsSubscriptionsRule_Spec) +
+Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline.
+| Field | +Description | +
|---|---|
+compatibilityLevel+ +int + + |
+
+ CompatibilityLevel: This property is reserved for future use. An integer value showing the compatibility level, +currently hard-coded to 20. + |
+
+requiresPreprocessing+ +bool + + |
+
+ RequiresPreprocessing: Value that indicates whether the rule action requires preprocessing. + |
+
+sqlExpression+ +string + + |
+
+ SqlExpression: The SQL expression. e.g. MyProperty=‘ABC’ + |
+
+(Appears on:NamespacesTopicsSubscriptionsRule_STATUS) +
+Represents a filter which is a composition of an expression and an action that is executed in the pub/sub pipeline.
+| Field | +Description | +
|---|---|
+compatibilityLevel+ +int + + |
+
+ CompatibilityLevel: This property is reserved for future use. An integer value showing the compatibility level, +currently hard-coded to 20. + |
+
+requiresPreprocessing+ +bool + + |
+
+ RequiresPreprocessing: Value that indicates whether the rule action requires preprocessing. + |
+
+sqlExpression+ +string + + |
+
+ SqlExpression: The SQL expression. e.g. MyProperty=‘ABC’ + |
+
string alias)+(Appears on:SystemData_STATUS) +
+| Value | +Description | +
|---|---|
"Application" |
++ |
"Key" |
++ |
"ManagedIdentity" |
++ |
"User" |
++ |
string alias)+(Appears on:SystemData_STATUS) +
+| Value | +Description | +
|---|---|
"Application" |
++ |
"Key" |
++ |
"ManagedIdentity" |
++ |
"User" |
++ |
+(Appears on:Namespace_STATUS, NamespacesAuthorizationRule_STATUS, NamespacesQueue_STATUS, NamespacesTopic_STATUS, NamespacesTopicsSubscription_STATUS, NamespacesTopicsSubscriptionsRule_STATUS) +
+Metadata pertaining to creation and last modification of the resource.
+| Field | +Description | +
|---|---|
+createdAt+ +string + + |
+
+ CreatedAt: The timestamp of resource creation (UTC). + |
+
+createdBy+ +string + + |
+
+ CreatedBy: The identity that created the resource. + |
+
+createdByType+ + +SystemData_CreatedByType_STATUS + + + |
+
+ CreatedByType: The type of identity that created the resource. + |
+
+lastModifiedAt+ +string + + |
+
+ LastModifiedAt: The type of identity that last modified the resource. + |
+
+lastModifiedBy+ +string + + |
+
+ LastModifiedBy: The identity that last modified the resource. + |
+
+lastModifiedByType+ + +SystemData_LastModifiedByType_STATUS + + + |
+
+ LastModifiedByType: The type of identity that last modified the resource. + |
+
+(Appears on:Identity) +
+Information about the user assigned identity for the resource
+| Field | +Description | +
|---|---|
+reference+ + +genruntime.ResourceReference + + + |
++ | +
+(Appears on:KeyVaultProperties) +
+| Field | +Description | +
|---|---|
+userAssignedIdentityReference+ + +genruntime.ResourceReference + + + |
+
+ UserAssignedIdentityReference: ARM ID of user Identity selected for encryption + |
+
+(Appears on:KeyVaultProperties_STATUS) +
+| Field | +Description | +
|---|---|
+userAssignedIdentity+ +string + + |
+
+ UserAssignedIdentity: ARM ID of user Identity selected for encryption + |
+
+(Appears on:Identity_STATUS) +
+Recognized Dictionary value.
+| Field | +Description | +
|---|---|
+clientId+ +string + + |
+
+ ClientId: Client Id of user assigned identity + |
+
+principalId+ +string + + |
+
+ PrincipalId: Principal Id of user assigned identity + |
+
Package v1api20240301 contains API Schema definitions for the signalrservice v1api20240301 API group
+string alias)+(Appears on:IPRule, SignalRNetworkACLs) +
+Azure Networking ACL Action.
+| Value | +Description | +
|---|---|
"Allow" |
++ |
"Deny" |
++ |
string alias)+(Appears on:IPRule_STATUS, SignalRNetworkACLs_STATUS) +
+Azure Networking ACL Action.
+| Value | +Description | +
|---|---|
"Allow" |
++ |
"Deny" |
++ |
string alias)| Value | +Description | +
|---|---|
"2024-03-01" |
++ |
Generator information: +- Generated from: /signalr/resource-manager/Microsoft.SignalRService/stable/2024-03-01/signalr.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customCertificates/{certificateName} +
| Field | +Description | +||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||
+spec+ + +CustomCertificate_Spec + + + |
+
+ + +
|
+||||||||||||||
+status+ + +CustomCertificate_STATUS + + + |
++ | +
+(Appears on:CustomCertificate_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:CustomCertificate) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. E.g. +“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” + |
+
+keyVaultBaseUri+ +string + + |
+
+ KeyVaultBaseUri: Base uri of the KeyVault that stores certificate. + |
+
+keyVaultSecretName+ +string + + |
+
+ KeyVaultSecretName: Certificate secret name. + |
+
+keyVaultSecretVersion+ +string + + |
+
+ KeyVaultSecretVersion: Certificate secret version. + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+provisioningState+ + +ProvisioningState_STATUS + + + |
+
+ ProvisioningState: Provisioning state of the resource. + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” + |
+
+(Appears on:CustomCertificate) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+keyVaultBaseUri+ +string + + |
+
+ KeyVaultBaseUri: Base uri of the KeyVault that stores certificate. + |
+
+keyVaultBaseUriFromConfig+ + +genruntime.ConfigMapReference + + + |
+
+ KeyVaultBaseUriFromConfig: Base uri of the KeyVault that stores certificate. + |
+
+keyVaultSecretName+ +string + + |
+
+ KeyVaultSecretName: Certificate secret name. + |
+
+keyVaultSecretVersion+ +string + + |
+
+ KeyVaultSecretVersion: Certificate secret version. + |
+
+operatorSpec+ + +CustomCertificateOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a signalrservice.azure.com/SignalR resource + |
+
Generator information: +- Generated from: /signalr/resource-manager/Microsoft.SignalRService/stable/2024-03-01/signalr.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/customDomains/{name} +
| Field | +Description | +||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||
+spec+ + +CustomDomain_Spec + + + |
+
+ + +
|
+||||||||||
+status+ + +CustomDomain_STATUS + + + |
++ | +
+(Appears on:CustomDomain_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:CustomDomain) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+customCertificate+ + +ResourceReference_STATUS + + + |
+
+ CustomCertificate: Reference to a resource. + |
+
+domainName+ +string + + |
+
+ DomainName: The custom domain name. + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. E.g. +“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+provisioningState+ + +ProvisioningState_STATUS + + + |
+
+ ProvisioningState: Provisioning state of the resource. + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” + |
+
+(Appears on:CustomDomain) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+customCertificate+ + +ResourceReference + + + |
+
+ CustomCertificate: Reference to a resource. + |
+
+domainName+ +string + + |
+
+ DomainName: The custom domain name. + |
+
+operatorSpec+ + +CustomDomainOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a signalrservice.azure.com/SignalR resource + |
+
string alias)+(Appears on:SignalRFeature) +
+FeatureFlags is the supported features of Azure SignalR service. +- ServiceMode: Flag for backend server for SignalR +service. Values allowed: “Default”: have your own backend server; “Serverless”: your application doesn’t have a backend +server; “Classic”: for backward compatibility. Support both Default and Serverless mode but not recommended; +“PredefinedOnly”: for future use. +- EnableConnectivityLogs: “true”/“false”, to enable/disable the connectivity log +category respectively. +- EnableMessagingLogs: “true”/“false”, to enable/disable the connectivity log category +respectively. +- EnableLiveTrace: Live Trace allows you to know what’s happening inside Azure SignalR service, it will +give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application +or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. +Values allowed: “true”/“false”, to enable/disable live trace feature.
+| Value | +Description | +
|---|---|
"EnableConnectivityLogs" |
++ |
"EnableLiveTrace" |
++ |
"EnableMessagingLogs" |
++ |
"ServiceMode" |
++ |
string alias)+(Appears on:SignalRFeature_STATUS) +
+FeatureFlags is the supported features of Azure SignalR service. +- ServiceMode: Flag for backend server for SignalR +service. Values allowed: “Default”: have your own backend server; “Serverless”: your application doesn’t have a backend +server; “Classic”: for backward compatibility. Support both Default and Serverless mode but not recommended; +“PredefinedOnly”: for future use. +- EnableConnectivityLogs: “true”/“false”, to enable/disable the connectivity log +category respectively. +- EnableMessagingLogs: “true”/“false”, to enable/disable the connectivity log category +respectively. +- EnableLiveTrace: Live Trace allows you to know what’s happening inside Azure SignalR service, it will +give you live traces in real time, it will be helpful when you developing your own Azure SignalR based web application +or self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. +Values allowed: “true”/“false”, to enable/disable live trace feature.
+| Value | +Description | +
|---|---|
"EnableConnectivityLogs" |
++ |
"EnableLiveTrace" |
++ |
"EnableMessagingLogs" |
++ |
"ServiceMode" |
++ |
+(Appears on:SignalRNetworkACLs) +
+An IP rule
+| Field | +Description | +
|---|---|
+action+ + +ACLAction + + + |
+
+ Action: Azure Networking ACL Action. + |
+
+value+ +string + + |
+
+ Value: An IP or CIDR or ServiceTag + |
+
+(Appears on:SignalRNetworkACLs_STATUS) +
+An IP rule
+| Field | +Description | +
|---|---|
+action+ + +ACLAction_STATUS + + + |
+
+ Action: Azure Networking ACL Action. + |
+
+value+ +string + + |
+
+ Value: An IP or CIDR or ServiceTag + |
+
+(Appears on:LiveTraceConfiguration) +
+Live trace category configuration of a Microsoft.SignalRService resource.
+| Field | +Description | +
|---|---|
+enabled+ +string + + |
+
+ Enabled: Indicates whether or the live trace category is enabled. +Available values: true, false. +Case insensitive. + |
+
+name+ +string + + |
+
+ Name: Gets or sets the live trace category’s name. +Available values: ConnectivityLogs, MessagingLogs. +Case insensitive. + |
+
+(Appears on:LiveTraceConfiguration_STATUS) +
+Live trace category configuration of a Microsoft.SignalRService resource.
+| Field | +Description | +
|---|---|
+enabled+ +string + + |
+
+ Enabled: Indicates whether or the live trace category is enabled. +Available values: true, false. +Case insensitive. + |
+
+name+ +string + + |
+
+ Name: Gets or sets the live trace category’s name. +Available values: ConnectivityLogs, MessagingLogs. +Case insensitive. + |
+
+(Appears on:SignalR_Spec) +
+Live trace configuration of a Microsoft.SignalRService resource.
+| Field | +Description | +
|---|---|
+categories+ + +[]LiveTraceCategory + + + |
+
+ Categories: Gets or sets the list of category configurations. + |
+
+enabled+ +string + + |
+
+ Enabled: Indicates whether or not enable live trace. +When it’s set to true, live trace client can connect to the service. +Otherwise, live trace client can’t connect to the service, so that you are unable to receive any log, no matter what you +configure in “categories”. +Available values: true, false. +Case insensitive. + |
+
+(Appears on:SignalR_STATUS) +
+Live trace configuration of a Microsoft.SignalRService resource.
+| Field | +Description | +
|---|---|
+categories+ + +[]LiveTraceCategory_STATUS + + + |
+
+ Categories: Gets or sets the list of category configurations. + |
+
+enabled+ +string + + |
+
+ Enabled: Indicates whether or not enable live trace. +When it’s set to true, live trace client can connect to the service. +Otherwise, live trace client can’t connect to the service, so that you are unable to receive any log, no matter what you +configure in “categories”. +Available values: true, false. +Case insensitive. + |
+
+(Appears on:SignalR_Spec) +
+A class represent managed identities used for request and response
+| Field | +Description | +
|---|---|
+type+ + +ManagedIdentityType + + + |
+
+ Type: Represents the identity type: systemAssigned, userAssigned, None + |
+
+userAssignedIdentities+ + +[]UserAssignedIdentityDetails + + + |
+
+ UserAssignedIdentities: Get or set the user assigned identities + |
+
+(Appears on:UpstreamAuthSettings) +
+Managed identity settings for upstream.
+| Field | +Description | +
|---|---|
+resource+ +string + + |
+
+ Resource: The Resource indicating the App ID URI of the target resource. +It also appears in the aud (audience) claim of the issued token. + |
+
+(Appears on:UpstreamAuthSettings_STATUS) +
+Managed identity settings for upstream.
+| Field | +Description | +
|---|---|
+resource+ +string + + |
+
+ Resource: The Resource indicating the App ID URI of the target resource. +It also appears in the aud (audience) claim of the issued token. + |
+
string alias)+(Appears on:ManagedIdentity) +
+Represents the identity type: systemAssigned, userAssigned, None
+| Value | +Description | +
|---|---|
"None" |
++ |
"SystemAssigned" |
++ |
"UserAssigned" |
++ |
string alias)+(Appears on:ManagedIdentity_STATUS) +
+Represents the identity type: systemAssigned, userAssigned, None
+| Value | +Description | +
|---|---|
"None" |
++ |
"SystemAssigned" |
++ |
"UserAssigned" |
++ |
+(Appears on:SignalR_STATUS) +
+A class represent managed identities used for request and response
+| Field | +Description | +
|---|---|
+principalId+ +string + + |
+
+ PrincipalId: Get the principal id for the system assigned identity. +Only be used in response. + |
+
+tenantId+ +string + + |
+
+ TenantId: Get the tenant id for the system assigned identity. +Only be used in response + |
+
+type+ + +ManagedIdentityType_STATUS + + + |
+
+ Type: Represents the identity type: systemAssigned, userAssigned, None + |
+
+userAssignedIdentities+ + +map[string]./api/signalrservice/v1api20240301.UserAssignedIdentityProperty_STATUS + + + |
+
+ UserAssignedIdentities: Get or set the user assigned identities + |
+
+(Appears on:SignalRNetworkACLs) +
+Network ACL
+| Field | +Description | +
|---|---|
+allow+ + +[]SignalRRequestType + + + |
+
+ Allow: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. + |
+
+deny+ + +[]SignalRRequestType + + + |
+
+ Deny: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. + |
+
+(Appears on:SignalRNetworkACLs_STATUS) +
+Network ACL
+| Field | +Description | +
|---|---|
+allow+ + +[]SignalRRequestType_STATUS + + + |
+
+ Allow: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. + |
+
+deny+ + +[]SignalRRequestType_STATUS + + + |
+
+ Deny: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. + |
+
+(Appears on:SignalRNetworkACLs) +
+ACL for a private endpoint
+| Field | +Description | +
|---|---|
+allow+ + +[]SignalRRequestType + + + |
+
+ Allow: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. + |
+
+deny+ + +[]SignalRRequestType + + + |
+
+ Deny: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. + |
+
+name+ +string + + |
+
+ Name: Name of the private endpoint connection + |
+
+(Appears on:SignalRNetworkACLs_STATUS) +
+ACL for a private endpoint
+| Field | +Description | +
|---|---|
+allow+ + +[]SignalRRequestType_STATUS + + + |
+
+ Allow: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. + |
+
+deny+ + +[]SignalRRequestType_STATUS + + + |
+
+ Deny: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI. + |
+
+name+ +string + + |
+
+ Name: Name of the private endpoint connection + |
+
+(Appears on:SignalR_STATUS) +
+A private endpoint connection to an azure resource
+| Field | +Description | +
|---|---|
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. E.g. +“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” + |
+
string alias)+(Appears on:CustomCertificate_STATUS, CustomDomain_STATUS, Replica_STATUS, SignalR_STATUS) +
+Provisioning state of the resource.
+| Value | +Description | +
|---|---|
"Canceled" |
++ |
"Creating" |
++ |
"Deleting" |
++ |
"Failed" |
++ |
"Moving" |
++ |
"Running" |
++ |
"Succeeded" |
++ |
"Unknown" |
++ |
"Updating" |
++ |
Generator information: +- Generated from: /signalr/resource-manager/Microsoft.SignalRService/stable/2024-03-01/signalr.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/replicas/{replicaName} +
| Field | +Description | +||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||
+spec+ + +Replica_Spec + + + |
+
+ + +
|
+||||||||||||||||
+status+ + +Replica_STATUS + + + |
++ | +
+(Appears on:Replica_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+(Appears on:Replica) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. E.g. +“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+provisioningState+ + +ProvisioningState_STATUS + + + |
+
+ ProvisioningState: Provisioning state of the resource. + |
+
+regionEndpointEnabled+ +string + + |
+
+ RegionEndpointEnabled: Enable or disable the regional endpoint. Default to “Enabled”. +When it’s Disabled, new connections will not be routed to this endpoint, however existing connections will not be +affected. + |
+
+resourceStopped+ +string + + |
+
+ ResourceStopped: Stop or start the resource. Default to “false”. +When it’s true, the data plane of the resource is shutdown. +When it’s false, the data plane of the resource is started. + |
+
+sku+ + +ResourceSku_STATUS + + + |
+
+ Sku: The billing information of the resource. + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” + |
+
+(Appears on:Replica) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+operatorSpec+ + +ReplicaOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a signalrservice.azure.com/SignalR resource + |
+
+regionEndpointEnabled+ +string + + |
+
+ RegionEndpointEnabled: Enable or disable the regional endpoint. Default to “Enabled”. +When it’s Disabled, new connections will not be routed to this endpoint, however existing connections will not be +affected. + |
+
+resourceStopped+ +string + + |
+
+ ResourceStopped: Stop or start the resource. Default to “false”. +When it’s true, the data plane of the resource is shutdown. +When it’s false, the data plane of the resource is started. + |
+
+sku+ + +ResourceSku + + + |
+
+ Sku: The billing information of the resource. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+(Appears on:ResourceLogConfiguration) +
+Resource log category configuration of a Microsoft.SignalRService resource.
+| Field | +Description | +
|---|---|
+enabled+ +string + + |
+
+ Enabled: Indicates whether or the resource log category is enabled. +Available values: true, false. +Case insensitive. + |
+
+name+ +string + + |
+
+ Name: Gets or sets the resource log category’s name. +Available values: ConnectivityLogs, MessagingLogs. +Case insensitive. + |
+
+(Appears on:ResourceLogConfiguration_STATUS) +
+Resource log category configuration of a Microsoft.SignalRService resource.
+| Field | +Description | +
|---|---|
+enabled+ +string + + |
+
+ Enabled: Indicates whether or the resource log category is enabled. +Available values: true, false. +Case insensitive. + |
+
+name+ +string + + |
+
+ Name: Gets or sets the resource log category’s name. +Available values: ConnectivityLogs, MessagingLogs. +Case insensitive. + |
+
+(Appears on:SignalR_Spec) +
+Resource log configuration of a Microsoft.SignalRService resource.
+| Field | +Description | +
|---|---|
+categories+ + +[]ResourceLogCategory + + + |
+
+ Categories: Gets or sets the list of category configurations. + |
+
+(Appears on:SignalR_STATUS) +
+Resource log configuration of a Microsoft.SignalRService resource.
+| Field | +Description | +
|---|---|
+categories+ + +[]ResourceLogCategory_STATUS + + + |
+
+ Categories: Gets or sets the list of category configurations. + |
+
+(Appears on:CustomDomain_Spec) +
+Reference to a resource.
+| Field | +Description | +
|---|---|
+reference+ + +genruntime.ResourceReference + + + |
+
+ Reference: Resource ID. + |
+
+(Appears on:CustomDomain_STATUS) +
+Reference to a resource.
+| Field | +Description | +
|---|---|
+id+ +string + + |
+
+ Id: Resource ID. + |
+
+(Appears on:Replica_Spec, SignalR_Spec) +
+The billing information of the resource.
+| Field | +Description | +
|---|---|
+capacity+ +int + + |
+
+ Capacity: Optional, integer. The unit count of the resource. +1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. +If present, following values are allowed: +Free_F1: 1; +Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; +Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; +Premium_P2: 100,200,300,400,500,600,700,800,900,1000; + |
+
+name+ +string + + |
+
+ Name: The name of the SKU. Required. +Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 + |
+
+tier+ + +SignalRSkuTier + + + |
+
+ Tier: Optional tier of this particular SKU. ‘Standard’ or ‘Free’.
+ |
+
+(Appears on:Replica_STATUS, SignalR_STATUS) +
+The billing information of the resource.
+| Field | +Description | +
|---|---|
+capacity+ +int + + |
+
+ Capacity: Optional, integer. The unit count of the resource. +1 for Free_F1/Standard_S1/Premium_P1, 100 for Premium_P2 by default. +If present, following values are allowed: +Free_F1: 1; +Standard_S1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; +Premium_P1: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; +Premium_P2: 100,200,300,400,500,600,700,800,900,1000; + |
+
+family+ +string + + |
+
+ Family: Not used. Retained for future use. + |
+
+name+ +string + + |
+
+ Name: The name of the SKU. Required. +Allowed values: Standard_S1, Free_F1, Premium_P1, Premium_P2 + |
+
+size+ +string + + |
+
+ Size: Not used. Retained for future use. + |
+
+tier+ + +SignalRSkuTier_STATUS + + + |
+
+ Tier: Optional tier of this particular SKU. ‘Standard’ or ‘Free’.
+ |
+
+(Appears on:SignalR_Spec) +
+Serverless settings.
+| Field | +Description | +
|---|---|
+connectionTimeoutInSeconds+ +int + + |
+
+ ConnectionTimeoutInSeconds: Gets or sets Client Connection Timeout. Optional to be set. +Value in seconds. +Default value is 30 seconds. +Customer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals, +and want the client to disconnect more quickly after the last message is sent. +You can set the timeout to a longer period if messages are expected to be sent in longer intervals, +and they want to keep the same client connection alive during this session. +The service considers the client disconnected if it hasn’t received a message (including keep-alive) in this interval. + |
+
+(Appears on:SignalR_STATUS) +
+Serverless settings.
+| Field | +Description | +
|---|---|
+connectionTimeoutInSeconds+ +int + + |
+
+ ConnectionTimeoutInSeconds: Gets or sets Client Connection Timeout. Optional to be set. +Value in seconds. +Default value is 30 seconds. +Customer should set the timeout to a shorter period if messages are expected to be sent in shorter intervals, +and want the client to disconnect more quickly after the last message is sent. +You can set the timeout to a longer period if messages are expected to be sent in longer intervals, +and they want to keep the same client connection alive during this session. +The service considers the client disconnected if it hasn’t received a message (including keep-alive) in this interval. + |
+
+(Appears on:SignalR_Spec) +
+The settings for the Upstream when the service is in server-less mode.
+| Field | +Description | +
|---|---|
+templates+ + +[]UpstreamTemplate + + + |
+
+ Templates: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. + |
+
+(Appears on:SignalR_STATUS) +
+The settings for the Upstream when the service is in server-less mode.
+| Field | +Description | +
|---|---|
+templates+ + +[]UpstreamTemplate_STATUS + + + |
+
+ Templates: Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects. + |
+
+(Appears on:SignalR_STATUS) +
+Describes a Shared Private Link Resource
+| Field | +Description | +
|---|---|
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. E.g. +“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” + |
+
Generator information: +- Generated from: /signalr/resource-manager/Microsoft.SignalRService/stable/2024-03-01/signalr.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName} +
| Field | +Description | +||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||||||||||||||||||||||||
+spec+ + +SignalR_Spec + + + |
+
+ + +
|
+||||||||||||||||||||||||||||||||||||||||||
+status+ + +SignalR_STATUS + + + |
++ | +
+(Appears on:SignalR_Spec) +
+Cross-Origin Resource Sharing (CORS) settings.
+| Field | +Description | +
|---|---|
+allowedOrigins+ +[]string + + |
+
+ AllowedOrigins: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: +http://example.com:12345). Use “*” to allow all. If omitted, allow all by default. + |
+
+(Appears on:SignalR_STATUS) +
+Cross-Origin Resource Sharing (CORS) settings.
+| Field | +Description | +
|---|---|
+allowedOrigins+ +[]string + + |
+
+ AllowedOrigins: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: +http://example.com:12345). Use “*” to allow all. If omitted, allow all by default. + |
+
+(Appears on:SignalR_Spec) +
+Feature of a resource, which controls the runtime behavior.
+| Field | +Description | +
|---|---|
+flag+ + +FeatureFlags + + + |
+
+ Flag: FeatureFlags is the supported features of Azure SignalR service. +- ServiceMode: Flag for backend server for SignalR service. Values allowed: “Default”: have your own backend server; +“Serverless”: your application doesn’t have a backend server; “Classic”: for backward compatibility. Support both +Default and Serverless mode but not recommended; “PredefinedOnly”: for future use. +- EnableConnectivityLogs: “true”/“false”, to enable/disable the connectivity log category respectively. +- EnableMessagingLogs: “true”/“false”, to enable/disable the connectivity log category respectively. +- EnableLiveTrace: Live Trace allows you to know what’s happening inside Azure SignalR service, it will give you live +traces in real time, it will be helpful when you developing your own Azure SignalR based web application or +self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. +Values allowed: “true”/“false”, to enable/disable live trace feature. + |
+
+properties+ +map[string]string + + |
+
+ Properties: Optional properties related to this feature. + |
+
+value+ +string + + |
+
+ Value: Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for +allowed values. + |
+
+(Appears on:SignalR_STATUS) +
+Feature of a resource, which controls the runtime behavior.
+| Field | +Description | +
|---|---|
+flag+ + +FeatureFlags_STATUS + + + |
+
+ Flag: FeatureFlags is the supported features of Azure SignalR service. +- ServiceMode: Flag for backend server for SignalR service. Values allowed: “Default”: have your own backend server; +“Serverless”: your application doesn’t have a backend server; “Classic”: for backward compatibility. Support both +Default and Serverless mode but not recommended; “PredefinedOnly”: for future use. +- EnableConnectivityLogs: “true”/“false”, to enable/disable the connectivity log category respectively. +- EnableMessagingLogs: “true”/“false”, to enable/disable the connectivity log category respectively. +- EnableLiveTrace: Live Trace allows you to know what’s happening inside Azure SignalR service, it will give you live +traces in real time, it will be helpful when you developing your own Azure SignalR based web application or +self-troubleshooting some issues. Please note that live traces are counted as outbound messages that will be charged. +Values allowed: “true”/“false”, to enable/disable live trace feature. + |
+
+properties+ +map[string]string + + |
+
+ Properties: Optional properties related to this feature. + |
+
+value+ +string + + |
+
+ Value: Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for +allowed values. + |
+
+(Appears on:SignalR_Spec) +
+Network ACLs for the resource
+| Field | +Description | +
|---|---|
+defaultAction+ + +ACLAction + + + |
+
+ DefaultAction: Azure Networking ACL Action. + |
+
+ipRules+ + +[]IPRule + + + |
+
+ IpRules: IP rules for filtering public traffic + |
+
+privateEndpoints+ + +[]PrivateEndpointACL + + + |
+
+ PrivateEndpoints: ACLs for requests from private endpoints + |
+
+publicNetwork+ + +NetworkACL + + + |
+
+ PublicNetwork: Network ACL + |
+
+(Appears on:SignalR_STATUS) +
+Network ACLs for the resource
+| Field | +Description | +
|---|---|
+defaultAction+ + +ACLAction_STATUS + + + |
+
+ DefaultAction: Azure Networking ACL Action. + |
+
+ipRules+ + +[]IPRule_STATUS + + + |
+
+ IpRules: IP rules for filtering public traffic + |
+
+privateEndpoints+ + +[]PrivateEndpointACL_STATUS + + + |
+
+ PrivateEndpoints: ACLs for requests from private endpoints + |
+
+publicNetwork+ + +NetworkACL_STATUS + + + |
+
+ PublicNetwork: Network ACL + |
+
+(Appears on:SignalROperatorSpec) +
+| Field | +Description | +
|---|---|
+primaryConnectionString+ + +genruntime.SecretDestination + + + |
+
+ PrimaryConnectionString: indicates where the PrimaryConnectionString secret should be placed. If omitted, the secret +will not be retrieved from Azure. + |
+
+primaryKey+ + +genruntime.SecretDestination + + + |
+
+ PrimaryKey: indicates where the PrimaryKey secret should be placed. If omitted, the secret will not be retrieved from +Azure. + |
+
+secondaryConnectionString+ + +genruntime.SecretDestination + + + |
+
+ SecondaryConnectionString: indicates where the SecondaryConnectionString secret should be placed. If omitted, the secret +will not be retrieved from Azure. + |
+
+secondaryKey+ + +genruntime.SecretDestination + + + |
+
+ SecondaryKey: indicates where the SecondaryKey secret should be placed. If omitted, the secret will not be retrieved +from Azure. + |
+
+(Appears on:SignalR_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMapExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). + |
+
+secretExpressions+ + +[]genruntime/core.DestinationExpression + + + |
+
+ SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). + |
+
+secrets+ + +SignalROperatorSecrets + + + |
+
+ Secrets: configures where to place Azure generated secrets. + |
+
string alias)+(Appears on:NetworkACL, PrivateEndpointACL) +
+The incoming request type to the service
+| Value | +Description | +
|---|---|
"ClientConnection" |
++ |
"RESTAPI" |
++ |
"ServerConnection" |
++ |
"Trace" |
++ |
string alias)+(Appears on:NetworkACL_STATUS, PrivateEndpointACL_STATUS) +
+The incoming request type to the service
+| Value | +Description | +
|---|---|
"ClientConnection" |
++ |
"RESTAPI" |
++ |
"ServerConnection" |
++ |
"Trace" |
++ |
string alias)+(Appears on:ResourceSku) +
+Optional tier of this particular SKU. ‘Standard’ or ‘Free’.
+Basic is deprecated, use Standard instead.
| Value | +Description | +
|---|---|
"Basic" |
++ |
"Free" |
++ |
"Premium" |
++ |
"Standard" |
++ |
string alias)+(Appears on:ResourceSku_STATUS) +
+Optional tier of this particular SKU. ‘Standard’ or ‘Free’.
+Basic is deprecated, use Standard instead.
| Value | +Description | +
|---|---|
"Basic" |
++ |
"Free" |
++ |
"Premium" |
++ |
"Standard" |
++ |
+(Appears on:SignalR_Spec) +
+TLS settings for the resource
+| Field | +Description | +
|---|---|
+clientCertEnabled+ +bool + + |
+
+ ClientCertEnabled: Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input +will be ignored for free tier. + |
+
+(Appears on:SignalR_STATUS) +
+TLS settings for the resource
+| Field | +Description | +
|---|---|
+clientCertEnabled+ +bool + + |
+
+ ClientCertEnabled: Request client certificate during TLS handshake if enabled. Not supported for free tier. Any input +will be ignored for free tier. + |
+
+(Appears on:SignalR) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+cors+ + +SignalRCorsSettings_STATUS + + + |
+
+ Cors: Cross-Origin Resource Sharing (CORS) settings. + |
+
+disableAadAuth+ +bool + + |
+
+ DisableAadAuth: DisableLocalAuth +Enable or disable aad auth +When set as true, connection with AuthType=aad won’t work. + |
+
+disableLocalAuth+ +bool + + |
+
+ DisableLocalAuth: DisableLocalAuth +Enable or disable local auth with AccessKey +When set as true, connection with AccessKey=xxx won’t work. + |
+
+externalIP+ +string + + |
+
+ ExternalIP: The publicly accessible IP of the resource. + |
+
+features+ + +[]SignalRFeature_STATUS + + + |
+
+ Features: List of the featureFlags. +FeatureFlags that are not included in the parameters for the update operation will not be modified. +And the response will only include featureFlags that are explicitly set. +When a featureFlag is not explicitly set, its globally default value will be used +But keep in mind, the default value doesn’t mean “false”. It varies in terms of different FeatureFlags. + |
+
+hostName+ +string + + |
+
+ HostName: FQDN of the service instance. + |
+
+hostNamePrefix+ +string + + |
+
+ HostNamePrefix: Deprecated. + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. E.g. +“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}” + |
+
+identity+ + +ManagedIdentity_STATUS + + + |
+
+ Identity: A class represent managed identities used for request and response + |
+
+kind+ + +SignalrServiceKind_STATUS + + + |
+
+ Kind: The kind of the service + |
+
+liveTraceConfiguration+ + +LiveTraceConfiguration_STATUS + + + |
+
+ LiveTraceConfiguration: Live trace configuration of a Microsoft.SignalRService resource. + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+networkACLs+ + +SignalRNetworkACLs_STATUS + + + |
+
+ NetworkACLs: Network ACLs for the resource + |
+
+privateEndpointConnections+ + +[]PrivateEndpointConnection_STATUS_SignalR_SubResourceEmbedded + + + |
+
+ PrivateEndpointConnections: Private endpoint connections to the resource. + |
+
+provisioningState+ + +ProvisioningState_STATUS + + + |
+
+ ProvisioningState: Provisioning state of the resource. + |
+
+publicNetworkAccess+ +string + + |
+
+ PublicNetworkAccess: Enable or disable public network access. Default to “Enabled”. +When it’s Enabled, network ACLs still apply. +When it’s Disabled, public network access is always disabled no matter what you set in network ACLs. + |
+
+publicPort+ +int + + |
+
+ PublicPort: The publicly accessible port of the resource which is designed for browser/client side usage. + |
+
+regionEndpointEnabled+ +string + + |
+
+ RegionEndpointEnabled: Enable or disable the regional endpoint. Default to “Enabled”. +When it’s Disabled, new connections will not be routed to this endpoint, however existing connections will not be +affected. +This property is replica specific. Disable the regional endpoint without replica is not allowed. + |
+
+resourceLogConfiguration+ + +ResourceLogConfiguration_STATUS + + + |
+
+ ResourceLogConfiguration: Resource log configuration of a Microsoft.SignalRService resource. + |
+
+resourceStopped+ +string + + |
+
+ ResourceStopped: Stop or start the resource. Default to “False”. +When it’s true, the data plane of the resource is shutdown. +When it’s false, the data plane of the resource is started. + |
+
+serverPort+ +int + + |
+
+ ServerPort: The publicly accessible port of the resource which is designed for customer server side usage. + |
+
+serverless+ + +ServerlessSettings_STATUS + + + |
+
+ Serverless: Serverless settings. + |
+
+sharedPrivateLinkResources+ + +[]SharedPrivateLinkResource_STATUS_SignalR_SubResourceEmbedded + + + |
+
+ SharedPrivateLinkResources: The list of shared private link resources. + |
+
+sku+ + +ResourceSku_STATUS + + + |
+
+ Sku: The billing information of the resource. + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+tls+ + +SignalRTlsSettings_STATUS + + + |
+
+ Tls: TLS settings for the resource + |
+
+type+ +string + + |
+
+ Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” + |
+
+upstream+ + +ServerlessUpstreamSettings_STATUS + + + |
+
+ Upstream: The settings for the Upstream when the service is in server-less mode. + |
+
+version+ +string + + |
+
+ Version: Version of the resource. Probably you need the same or higher version of client SDKs. + |
+
+(Appears on:SignalR) +
+| Field | +Description | +
|---|---|
+azureName+ +string + + |
+
+ AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it +doesn’t have to be. + |
+
+cors+ + +SignalRCorsSettings + + + |
+
+ Cors: Cross-Origin Resource Sharing (CORS) settings. + |
+
+disableAadAuth+ +bool + + |
+
+ DisableAadAuth: DisableLocalAuth +Enable or disable aad auth +When set as true, connection with AuthType=aad won’t work. + |
+
+disableLocalAuth+ +bool + + |
+
+ DisableLocalAuth: DisableLocalAuth +Enable or disable local auth with AccessKey +When set as true, connection with AccessKey=xxx won’t work. + |
+
+features+ + +[]SignalRFeature + + + |
+
+ Features: List of the featureFlags. +FeatureFlags that are not included in the parameters for the update operation will not be modified. +And the response will only include featureFlags that are explicitly set. +When a featureFlag is not explicitly set, its globally default value will be used +But keep in mind, the default value doesn’t mean “false”. It varies in terms of different FeatureFlags. + |
+
+identity+ + +ManagedIdentity + + + |
+
+ Identity: A class represent managed identities used for request and response + |
+
+kind+ + +SignalrServiceKind + + + |
+
+ Kind: The kind of the service + |
+
+liveTraceConfiguration+ + +LiveTraceConfiguration + + + |
+
+ LiveTraceConfiguration: Live trace configuration of a Microsoft.SignalRService resource. + |
+
+location+ +string + + |
+
+ Location: The geo-location where the resource lives + |
+
+networkACLs+ + +SignalRNetworkACLs + + + |
+
+ NetworkACLs: Network ACLs for the resource + |
+
+operatorSpec+ + +SignalROperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
+
+owner+ + +genruntime.KnownResourceReference + + + |
+
+ Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also +controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a +reference to a resources.azure.com/ResourceGroup resource + |
+
+publicNetworkAccess+ +string + + |
+
+ PublicNetworkAccess: Enable or disable public network access. Default to “Enabled”. +When it’s Enabled, network ACLs still apply. +When it’s Disabled, public network access is always disabled no matter what you set in network ACLs. + |
+
+regionEndpointEnabled+ +string + + |
+
+ RegionEndpointEnabled: Enable or disable the regional endpoint. Default to “Enabled”. +When it’s Disabled, new connections will not be routed to this endpoint, however existing connections will not be +affected. +This property is replica specific. Disable the regional endpoint without replica is not allowed. + |
+
+resourceLogConfiguration+ + +ResourceLogConfiguration + + + |
+
+ ResourceLogConfiguration: Resource log configuration of a Microsoft.SignalRService resource. + |
+
+resourceStopped+ +string + + |
+
+ ResourceStopped: Stop or start the resource. Default to “False”. +When it’s true, the data plane of the resource is shutdown. +When it’s false, the data plane of the resource is started. + |
+
+serverless+ + +ServerlessSettings + + + |
+
+ Serverless: Serverless settings. + |
+
+sku+ + +ResourceSku + + + |
+
+ Sku: The billing information of the resource. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+tls+ + +SignalRTlsSettings + + + |
+
+ Tls: TLS settings for the resource + |
+
+upstream+ + +ServerlessUpstreamSettings + + + |
+
+ Upstream: The settings for the Upstream when the service is in server-less mode. + |
+
string alias)+(Appears on:SignalR_Spec) +
+The kind of the service
+| Value | +Description | +
|---|---|
"RawWebSockets" |
++ |
"SignalR" |
++ |
string alias)+(Appears on:SignalR_STATUS) +
+The kind of the service
+| Value | +Description | +
|---|---|
"RawWebSockets" |
++ |
"SignalR" |
++ |
string alias)+(Appears on:SystemData_STATUS) +
+| Value | +Description | +
|---|---|
"Application" |
++ |
"Key" |
++ |
"ManagedIdentity" |
++ |
"User" |
++ |
string alias)+(Appears on:SystemData_STATUS) +
+| Value | +Description | +
|---|---|
"Application" |
++ |
"Key" |
++ |
"ManagedIdentity" |
++ |
"User" |
++ |
+(Appears on:CustomCertificate_STATUS, CustomDomain_STATUS, Replica_STATUS, SignalR_STATUS) +
+Metadata pertaining to creation and last modification of the resource.
+| Field | +Description | +
|---|---|
+createdAt+ +string + + |
+
+ CreatedAt: The timestamp of resource creation (UTC). + |
+
+createdBy+ +string + + |
+
+ CreatedBy: The identity that created the resource. + |
+
+createdByType+ + +SystemData_CreatedByType_STATUS + + + |
+
+ CreatedByType: The type of identity that created the resource. + |
+
+lastModifiedAt+ +string + + |
+
+ LastModifiedAt: The timestamp of resource last modification (UTC) + |
+
+lastModifiedBy+ +string + + |
+
+ LastModifiedBy: The identity that last modified the resource. + |
+
+lastModifiedByType+ + +SystemData_LastModifiedByType_STATUS + + + |
+
+ LastModifiedByType: The type of identity that last modified the resource. + |
+
+(Appears on:UpstreamTemplate) +
+Upstream auth settings. If not set, no auth is used for upstream messages.
+| Field | +Description | +
|---|---|
+managedIdentity+ + +ManagedIdentitySettings + + + |
+
+ ManagedIdentity: Managed identity settings for upstream. + |
+
+type+ + +UpstreamAuthType + + + |
+
+ Type: Upstream auth type enum. + |
+
+(Appears on:UpstreamTemplate_STATUS) +
+Upstream auth settings. If not set, no auth is used for upstream messages.
+| Field | +Description | +
|---|---|
+managedIdentity+ + +ManagedIdentitySettings_STATUS + + + |
+
+ ManagedIdentity: Managed identity settings for upstream. + |
+
+type+ + +UpstreamAuthType_STATUS + + + |
+
+ Type: Upstream auth type enum. + |
+
string alias)+(Appears on:UpstreamAuthSettings) +
+Upstream auth type enum.
+| Value | +Description | +
|---|---|
"ManagedIdentity" |
++ |
"None" |
++ |
string alias)+(Appears on:UpstreamAuthSettings_STATUS) +
+Upstream auth type enum.
+| Value | +Description | +
|---|---|
"ManagedIdentity" |
++ |
"None" |
++ |
+(Appears on:ServerlessUpstreamSettings) +
+Upstream template item settings. It defines the Upstream URL of the incoming requests. +The template defines the pattern +of the event, the hub or the category of the incoming request that matches current URL template.
+| Field | +Description | +
|---|---|
+auth+ + +UpstreamAuthSettings + + + |
+
+ Auth: Upstream auth settings. If not set, no auth is used for upstream messages. + |
+
+categoryPattern+ +string + + |
+
+ CategoryPattern: Gets or sets the matching pattern for category names. If not set, it matches any category. +There are 3 kind of patterns supported: +1. “*”, it to matches any category name. +2. Combine multiple categories with “,”, for example “connections,messages”, it matches category “connections” and +“messages”. +3. The single category name, for example, “connections”, it matches the category “connections”. + |
+
+eventPattern+ +string + + |
+
+ EventPattern: Gets or sets the matching pattern for event names. If not set, it matches any event. +There are 3 kind of patterns supported: +1. “*”, it to matches any event name. +2. Combine multiple events with “,”, for example “connect,disconnect”, it matches event “connect” and “disconnect”. +3. The single event name, for example, “connect”, it matches “connect”. + |
+
+hubPattern+ +string + + |
+
+ HubPattern: Gets or sets the matching pattern for hub names. If not set, it matches any hub. +There are 3 kind of patterns supported: +1. “*”, it to matches any hub name. +2. Combine multiple hubs with “,”, for example “hub1,hub2”, it matches “hub1” and “hub2”. +3. The single hub name, for example, “hub1”, it matches “hub1”. + |
+
+urlTemplate+ +string + + |
+
+ UrlTemplate: Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event}
+inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in.
+For example, if the urlTemplate is |
+
+(Appears on:ServerlessUpstreamSettings_STATUS) +
+Upstream template item settings. It defines the Upstream URL of the incoming requests. +The template defines the pattern +of the event, the hub or the category of the incoming request that matches current URL template.
+| Field | +Description | +
|---|---|
+auth+ + +UpstreamAuthSettings_STATUS + + + |
+
+ Auth: Upstream auth settings. If not set, no auth is used for upstream messages. + |
+
+categoryPattern+ +string + + |
+
+ CategoryPattern: Gets or sets the matching pattern for category names. If not set, it matches any category. +There are 3 kind of patterns supported: +1. “*”, it to matches any category name. +2. Combine multiple categories with “,”, for example “connections,messages”, it matches category “connections” and +“messages”. +3. The single category name, for example, “connections”, it matches the category “connections”. + |
+
+eventPattern+ +string + + |
+
+ EventPattern: Gets or sets the matching pattern for event names. If not set, it matches any event. +There are 3 kind of patterns supported: +1. “*”, it to matches any event name. +2. Combine multiple events with “,”, for example “connect,disconnect”, it matches event “connect” and “disconnect”. +3. The single event name, for example, “connect”, it matches “connect”. + |
+
+hubPattern+ +string + + |
+
+ HubPattern: Gets or sets the matching pattern for hub names. If not set, it matches any hub. +There are 3 kind of patterns supported: +1. “*”, it to matches any hub name. +2. Combine multiple hubs with “,”, for example “hub1,hub2”, it matches “hub1” and “hub2”. +3. The single hub name, for example, “hub1”, it matches “hub1”. + |
+
+urlTemplate+ +string + + |
+
+ UrlTemplate: Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event}
+inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in.
+For example, if the urlTemplate is |
+
+(Appears on:ManagedIdentity) +
+Information about the user assigned identity for the resource
+| Field | +Description | +
|---|---|
+reference+ + +genruntime.ResourceReference + + + |
++ | +
+(Appears on:ManagedIdentity_STATUS) +
+Properties of user assigned identity.
+| Field | +Description | +
|---|---|
+clientId+ +string + + |
+
+ ClientId: Get the client id for the user assigned identity + |
+
+principalId+ +string + + |
+
+ PrincipalId: Get the principal id for the user assigned identity + |
+