Package v1api20240101 contains API Schema definitions for the eventhub v1api20240101 API group
+string alias)| Value | +Description | +
|---|---|
"2024-01-01" |
++ |
+(Appears on:NamespacesEventhub_Spec) +
+Properties to configure capture description for eventhub
+| Field | +Description | +
|---|---|
+destination+ + +Destination + + + |
+
+ Destination: Properties of Destination where capture will be stored. (Storage Account, Blob Names) + |
+
+enabled+ +bool + + |
+
+ Enabled: A value that indicates whether capture description is enabled. + |
+
+encoding+ + +CaptureDescription_Encoding + + + |
+
+ Encoding: Enumerates the possible values for the encoding format of capture description. Note: ‘AvroDeflate’ will be +deprecated in New API Version + |
+
+intervalInSeconds+ +int + + |
+
+ IntervalInSeconds: The time window allows you to set the frequency with which the capture to Azure Blobs will happen, +value should between 60 to 900 seconds + |
+
+sizeLimitInBytes+ +int + + |
+
+ SizeLimitInBytes: The size window defines the amount of data built up in your Event Hub before an capture operation, +value should be between 10485760 to 524288000 bytes + |
+
+skipEmptyArchives+ +bool + + |
+
+ SkipEmptyArchives: A value that indicates whether to Skip Empty Archives + |
+
string alias)+(Appears on:CaptureDescription) +
+| Value | +Description | +
|---|---|
"Avro" |
++ |
"AvroDeflate" |
++ |
string alias)+(Appears on:CaptureDescription_STATUS) +
+| Value | +Description | +
|---|---|
"Avro" |
++ |
"AvroDeflate" |
++ |
+(Appears on:NamespacesEventhub_STATUS) +
+Properties to configure capture description for eventhub
+| Field | +Description | +
|---|---|
+destination+ + +Destination_STATUS + + + |
+
+ Destination: Properties of Destination where capture will be stored. (Storage Account, Blob Names) + |
+
+enabled+ +bool + + |
+
+ Enabled: A value that indicates whether capture description is enabled. + |
+
+encoding+ + +CaptureDescription_Encoding_STATUS + + + |
+
+ Encoding: Enumerates the possible values for the encoding format of capture description. Note: ‘AvroDeflate’ will be +deprecated in New API Version + |
+
+intervalInSeconds+ +int + + |
+
+ IntervalInSeconds: The time window allows you to set the frequency with which the capture to Azure Blobs will happen, +value should between 60 to 900 seconds + |
+
+sizeLimitInBytes+ +int + + |
+
+ SizeLimitInBytes: The size window defines the amount of data built up in your Event Hub before an capture operation, +value should be between 10485760 to 524288000 bytes + |
+
+skipEmptyArchives+ +bool + + |
+
+ SkipEmptyArchives: A value that indicates whether to Skip Empty Archives + |
+
+(Appears on:Destination) +
+A value that indicates whether capture description is enabled.
+| Field | +Description | +
|---|---|
+type+ + +CaptureIdentity_Type + + + |
+
+ Type: Type of Azure Active Directory Managed Identity. + |
+
+userAssignedIdentityReference+ + +genruntime.ResourceReference + + + |
+
+ UserAssignedIdentityReference: ARM ID of Managed User Identity. This property is required is the type is +UserAssignedIdentity. If type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be +used. + |
+
+(Appears on:Destination_STATUS) +
+A value that indicates whether capture description is enabled.
+| Field | +Description | +
|---|---|
+type+ + +CaptureIdentity_Type_STATUS + + + |
+
+ Type: Type of Azure Active Directory Managed Identity. + |
+
+userAssignedIdentity+ +string + + |
+
+ UserAssignedIdentity: ARM ID of Managed User Identity. This property is required is the type is UserAssignedIdentity. If +type is SystemAssigned, then the System Assigned Identity Associated with the namespace will be used. + |
+
string alias)+(Appears on:CaptureIdentity) +
+| Value | +Description | +
|---|---|
"SystemAssigned" |
++ |
"UserAssigned" |
++ |
string alias)+(Appears on:CaptureIdentity_STATUS) +
+| Value | +Description | +
|---|---|
"SystemAssigned" |
++ |
"UserAssigned" |
++ |
+(Appears on:CaptureDescription) +
+Capture storage details for capture description
+| Field | +Description | +
|---|---|
+archiveNameFormat+ +string + + |
+
+ ArchiveNameFormat: Blob naming convention for archive, e.g. +{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters +(Namespace,EventHub .. etc) are mandatory irrespective of order + |
+
+blobContainer+ +string + + |
+
+ BlobContainer: Blob container Name + |
+
+dataLakeAccountName+ +string + + |
+
+ DataLakeAccountName: The Azure Data Lake Store name for the captured events + |
+
+dataLakeFolderPath+ +string + + |
+
+ DataLakeFolderPath: The destination folder path for the captured events + |
+
+dataLakeSubscriptionId+ +string + + |
+
+ DataLakeSubscriptionId: Subscription Id of Azure Data Lake Store + |
+
+identity+ + +CaptureIdentity + + + |
+
+ Identity: A value that indicates whether capture description is enabled. + |
+
+name+ +string + + |
+
+ Name: Name for capture destination + |
+
+storageAccountResourceReference+ + +genruntime.ResourceReference + + + |
+
+ StorageAccountResourceReference: Resource id of the storage account to be used to create the blobs + |
+
+(Appears on:CaptureDescription_STATUS) +
+Capture storage details for capture description
+| Field | +Description | +
|---|---|
+archiveNameFormat+ +string + + |
+
+ ArchiveNameFormat: Blob naming convention for archive, e.g. +{Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters +(Namespace,EventHub .. etc) are mandatory irrespective of order + |
+
+blobContainer+ +string + + |
+
+ BlobContainer: Blob container Name + |
+
+dataLakeAccountName+ +string + + |
+
+ DataLakeAccountName: The Azure Data Lake Store name for the captured events + |
+
+dataLakeFolderPath+ +string + + |
+
+ DataLakeFolderPath: The destination folder path for the captured events + |
+
+dataLakeSubscriptionId+ +string + + |
+
+ DataLakeSubscriptionId: Subscription Id of Azure Data Lake Store + |
+
+identity+ + +CaptureIdentity_STATUS + + + |
+
+ Identity: A value that indicates whether capture description is enabled. + |
+
+name+ +string + + |
+
+ Name: Name for capture destination + |
+
+storageAccountResourceId+ +string + + |
+
+ StorageAccountResourceId: Resource id of the storage account to be used to create the blobs + |
+
+(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) + |
+
+(Appears on:Namespace_Spec) +
+Properties to configure Identity 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 Identity 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/eventhub/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: Key Version + |
+
+(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: Key Version + |
+
Generator information: +- Generated from: /eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/namespaces.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/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 | +
|---|---|
+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. + |
+
string alias)+(Appears on:Namespace_STATUS) +
+| Value | +Description | +
|---|---|
"1.0" |
++ |
"1.1" |
++ |
"1.2" |
++ |
string alias)+(Appears on:Namespace_Spec) +
+| Value | +Description | +
|---|---|
"1.0" |
++ |
"1.1" |
++ |
"1.2" |
++ |
string alias)+(Appears on:Namespace_STATUS) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
"SecuredByPerimeter" |
++ |
string alias)+(Appears on:Namespace_Spec) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
"SecuredByPerimeter" |
++ |
+(Appears on:Namespace) +
+| Field | +Description | +
|---|---|
+alternateName+ +string + + |
+
+ AlternateName: Alternate name specified when alias and namespace names are same. + |
+
+clusterArmId+ +string + + |
+
+ ClusterArmId: Cluster ARM ID of the 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 Event Hubs namespace. + |
+
+encryption+ + +Encryption_STATUS + + + |
+
+ Encryption: Properties of BYOK Encryption description + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource ID for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} + |
+
+identity+ + +Identity_STATUS + + + |
+
+ Identity: Properties of BYOK Identity description + |
+
+isAutoInflateEnabled+ +bool + + |
+
+ IsAutoInflateEnabled: Value that indicates whether AutoInflate is enabled for eventhub namespace. + |
+
+kafkaEnabled+ +bool + + |
+
+ KafkaEnabled: Value that indicates whether Kafka is enabled for eventhub namespace. + |
+
+location+ +string + + |
+
+ Location: Resource location. + |
+
+maximumThroughputUnits+ +int + + |
+
+ MaximumThroughputUnits: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 +throughput units. ( ‘0’ if AutoInflateEnabled = true) + |
+
+metricId+ +string + + |
+
+ MetricId: Identifier for Azure Insights metrics. + |
+
+minimumTlsVersion+ + +Namespace_Properties_MinimumTlsVersion_STATUS + + + |
+
+ MinimumTlsVersion: The minimum TLS version for the cluster to support, e.g. ‘1.2’ + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+privateEndpointConnections+ + +[]PrivateEndpointConnection_STATUS + + + |
+
+ PrivateEndpointConnections: List of private endpoint connections. + |
+
+provisioningState+ +string + + |
+
+ ProvisioningState: Provisioning state of the Namespace. + |
+
+publicNetworkAccess+ + +Namespace_Properties_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+ + +Sku_STATUS + + + |
+
+ Sku: Properties of sku resource + |
+
+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: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts” + |
+
+updatedAt+ +string + + |
+
+ UpdatedAt: The time the Namespace was updated. + |
+
+zoneRedundant+ +bool + + |
+
+ ZoneRedundant: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. + |
+
+(Appears on:Namespace) +
+| Field | +Description | +
|---|---|
+alternateName+ +string + + |
+
+ AlternateName: Alternate name specified when alias and namespace names are same. + |
+
+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. + |
+
+clusterArmReference+ + +genruntime.ResourceReference + + + |
+
+ ClusterArmReference: Cluster ARM ID of the Namespace. + |
+
+disableLocalAuth+ +bool + + |
+
+ DisableLocalAuth: This property disables SAS authentication for the Event Hubs namespace. + |
+
+encryption+ + +Encryption + + + |
+
+ Encryption: Properties of BYOK Encryption description + |
+
+identity+ + +Identity + + + |
+
+ Identity: Properties of BYOK Identity description + |
+
+isAutoInflateEnabled+ +bool + + |
+
+ IsAutoInflateEnabled: Value that indicates whether AutoInflate is enabled for eventhub namespace. + |
+
+kafkaEnabled+ +bool + + |
+
+ KafkaEnabled: Value that indicates whether Kafka is enabled for eventhub namespace. + |
+
+location+ +string + + |
+
+ Location: Resource location. + |
+
+maximumThroughputUnits+ +int + + |
+
+ MaximumThroughputUnits: Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 +throughput units. ( ‘0’ if AutoInflateEnabled = true) + |
+
+minimumTlsVersion+ + +Namespace_Properties_MinimumTlsVersion_Spec + + + |
+
+ 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 + |
+
+publicNetworkAccess+ + +Namespace_Properties_PublicNetworkAccess_Spec + + + |
+
+ PublicNetworkAccess: This determines if traffic is allowed over public network. By default it is enabled. + |
+
+sku+ + +Sku + + + |
+
+ Sku: Properties of sku resource + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+zoneRedundant+ +bool + + |
+
+ ZoneRedundant: Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones. + |
+
Generator information: +- Generated from: /eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/AuthorizationRules.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/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 eventhub.azure.com/Namespace resource + |
+
+rights+ + +[]Namespaces_AuthorizationRule_Properties_Rights_Spec + + + |
+
+ Rights: The rights associated with the rule. + |
+
Generator information: +- Generated from: /eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/eventhubs.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName} +
| Field | +Description | +||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||
+spec+ + +NamespacesEventhub_Spec + + + |
+
+ + +
|
+||||||||||||||||
+status+ + +NamespacesEventhub_STATUS + + + |
++ | +
+(Appears on:NamespacesEventhub_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:NamespacesEventhub) +
+| Field | +Description | +
|---|---|
+captureDescription+ + +CaptureDescription_STATUS + + + |
+
+ CaptureDescription: Properties of capture description + |
+
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+createdAt+ +string + + |
+
+ CreatedAt: Exact time the Event Hub was created. + |
+
+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 + |
+
+messageRetentionInDays+ +int + + |
+
+ MessageRetentionInDays: Number of days to retain the events for this Event Hub, value should be 1 to 7 days + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+partitionCount+ +int + + |
+
+ PartitionCount: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. + |
+
+partitionIds+ +[]string + + |
+
+ PartitionIds: Current number of shards on the Event Hub. + |
+
+retentionDescription+ + +RetentionDescription_STATUS + + + |
+
+ RetentionDescription: Event Hub retention settings + |
+
+status+ + +Namespaces_Eventhub_Properties_Status_STATUS + + + |
+
+ Status: Enumerates the possible values for the status of the Event Hub. + |
+
+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. + |
+
+userMetadata+ +string + + |
+
+ UserMetadata: Gets and Sets Metadata of User. + |
+
+(Appears on:NamespacesEventhub) +
+| 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. + |
+
+captureDescription+ + +CaptureDescription + + + |
+
+ CaptureDescription: Properties of capture description + |
+
+messageRetentionInDays+ +int + + |
+
+ MessageRetentionInDays: Number of days to retain the events for this Event Hub, value should be 1 to 7 days + |
+
+operatorSpec+ + +NamespacesEventhubOperatorSpec + + + |
+
+ 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 eventhub.azure.com/Namespace resource + |
+
+partitionCount+ +int + + |
+
+ PartitionCount: Number of partitions created for the Event Hub, allowed values are from 1 to 32 partitions. + |
+
+retentionDescription+ + +RetentionDescription + + + |
+
+ RetentionDescription: Event Hub retention settings + |
+
+userMetadata+ +string + + |
+
+ UserMetadata: Gets and Sets Metadata of User. + |
+
Generator information: +- Generated from: /eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/AuthorizationRules.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/authorizationRules/{authorizationRuleName} +
| Field | +Description | +||||||||
|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||
+spec+ + +NamespacesEventhubsAuthorizationRule_Spec + + + |
+
+ + +
|
+||||||||
+status+ + +NamespacesEventhubsAuthorizationRule_STATUS + + + |
++ | +
+(Appears on:NamespacesEventhubsAuthorizationRuleOperatorSpec) +
+| 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:NamespacesEventhubsAuthorizationRule_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+ + +NamespacesEventhubsAuthorizationRuleOperatorSecrets + + + |
+
+ Secrets: configures where to place Azure generated secrets. + |
+
+(Appears on:NamespacesEventhubsAuthorizationRule) +
+| 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_Eventhubs_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:NamespacesEventhubsAuthorizationRule) +
+| 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+ + +NamespacesEventhubsAuthorizationRuleOperatorSpec + + + |
+
+ 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 eventhub.azure.com/NamespacesEventhub resource + |
+
+rights+ + +[]Namespaces_Eventhubs_AuthorizationRule_Properties_Rights_Spec + + + |
+
+ Rights: The rights associated with the rule. + |
+
Generator information: +- Generated from: /eventhub/resource-manager/Microsoft.EventHub/stable/2024-01-01/consumergroups.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/eventhubs/{eventHubName}/consumergroups/{consumerGroupName} +
| Field | +Description | +||||||||
|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||
+spec+ + +NamespacesEventhubsConsumerGroup_Spec + + + |
+
+ + +
|
+||||||||
+status+ + +NamespacesEventhubsConsumerGroup_STATUS + + + |
++ | +
+(Appears on:NamespacesEventhubsConsumerGroup_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:NamespacesEventhubsConsumerGroup) +
+| Field | +Description | +
|---|---|
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+createdAt+ +string + + |
+
+ CreatedAt: Exact time the message was created. + |
+
+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 + |
+
+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. + |
+
+userMetadata+ +string + + |
+
+ UserMetadata: User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be +used to store descriptive data, such as list of teams and their contact information also user-defined configuration +settings can be stored. + |
+
+(Appears on:NamespacesEventhubsConsumerGroup) +
+| 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+ + +NamespacesEventhubsConsumerGroupOperatorSpec + + + |
+
+ 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 eventhub.azure.com/NamespacesEventhub resource + |
+
+userMetadata+ +string + + |
+
+ UserMetadata: User Metadata is a placeholder to store user-defined string data with maximum length 1024. e.g. it can be +used to store descriptive data, such as list of teams and their contact information also user-defined configuration +settings can be stored. + |
+
string alias)+(Appears on:NamespacesAuthorizationRule_STATUS) +
+| Value | +Description | +
|---|---|
"Listen" |
++ |
"Manage" |
++ |
"Send" |
++ |
string alias)+(Appears on:NamespacesAuthorizationRule_Spec) +
+| Value | +Description | +
|---|---|
"Listen" |
++ |
"Manage" |
++ |
"Send" |
++ |
string alias)+(Appears on:NamespacesEventhub_STATUS) +
+| Value | +Description | +
|---|---|
"Active" |
++ |
"Creating" |
++ |
"Deleting" |
++ |
"Disabled" |
++ |
"ReceiveDisabled" |
++ |
"Renaming" |
++ |
"Restoring" |
++ |
"SendDisabled" |
++ |
"Unknown" |
++ |
string alias)+(Appears on:NamespacesEventhubsAuthorizationRule_STATUS) +
+| Value | +Description | +
|---|---|
"Listen" |
++ |
"Manage" |
++ |
"Send" |
++ |
string alias)+(Appears on:NamespacesEventhubsAuthorizationRule_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:NamespacesEventhub_Spec) +
+Properties to configure retention settings for the eventhub
+| Field | +Description | +
|---|---|
+cleanupPolicy+ + +RetentionDescription_CleanupPolicy + + + |
+
+ CleanupPolicy: Enumerates the possible values for cleanup policy + |
+
+retentionTimeInHours+ +int + + |
+
+ RetentionTimeInHours: Number of hours to retain the events for this Event Hub. This value is only used when +cleanupPolicy is Delete. If cleanupPolicy is Compact the returned value of this property is Long.MaxValue + |
+
+tombstoneRetentionTimeInHours+ +int + + |
+
+ TombstoneRetentionTimeInHours: Number of hours to retain the tombstone markers of a compacted Event Hub. This value is +only used when cleanupPolicy is Compact. Consumer must complete reading the tombstone marker within this specified +amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key +described by the tombstone marker within the compacted Event Hub + |
+
string alias)+(Appears on:RetentionDescription) +
+| Value | +Description | +
|---|---|
"Compact" |
++ |
"Delete" |
++ |
string alias)+(Appears on:RetentionDescription_STATUS) +
+| Value | +Description | +
|---|---|
"Compact" |
++ |
"Delete" |
++ |
+(Appears on:NamespacesEventhub_STATUS) +
+Properties to configure retention settings for the eventhub
+| Field | +Description | +
|---|---|
+cleanupPolicy+ + +RetentionDescription_CleanupPolicy_STATUS + + + |
+
+ CleanupPolicy: Enumerates the possible values for cleanup policy + |
+
+retentionTimeInHours+ +int + + |
+
+ RetentionTimeInHours: Number of hours to retain the events for this Event Hub. This value is only used when +cleanupPolicy is Delete. If cleanupPolicy is Compact the returned value of this property is Long.MaxValue + |
+
+tombstoneRetentionTimeInHours+ +int + + |
+
+ TombstoneRetentionTimeInHours: Number of hours to retain the tombstone markers of a compacted Event Hub. This value is +only used when cleanupPolicy is Compact. Consumer must complete reading the tombstone marker within this specified +amount of time if consumer begins from starting offset to ensure they get a valid snapshot for the specific key +described by the tombstone marker within the compacted Event Hub + |
+
+(Appears on:Namespace_Spec) +
+SKU parameters supplied to the create namespace operation
+| Field | +Description | +
|---|---|
+capacity+ +int + + |
+
+ Capacity: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. +The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. + |
+
+name+ + +Sku_Name + + + |
+
+ Name: Name of this SKU. + |
+
+tier+ + +Sku_Tier + + + |
+
+ Tier: The billing tier of this particular SKU. + |
+
string alias)+(Appears on:Sku) +
+| Value | +Description | +
|---|---|
"Basic" |
++ |
"Premium" |
++ |
"Standard" |
++ |
string alias)+(Appears on:Sku_STATUS) +
+| Value | +Description | +
|---|---|
"Basic" |
++ |
"Premium" |
++ |
"Standard" |
++ |
+(Appears on:Namespace_STATUS) +
+SKU parameters supplied to the create namespace operation
+| Field | +Description | +
|---|---|
+capacity+ +int + + |
+
+ Capacity: The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. +The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units. + |
+
+name+ + +Sku_Name_STATUS + + + |
+
+ Name: Name of this SKU. + |
+
+tier+ + +Sku_Tier_STATUS + + + |
+
+ Tier: The billing tier of this particular SKU. + |
+
string alias)+(Appears on:Sku) +
+| Value | +Description | +
|---|---|
"Basic" |
++ |
"Premium" |
++ |
"Standard" |
++ |
string alias)+(Appears on:Sku_STATUS) +
+| Value | +Description | +
|---|---|
"Basic" |
++ |
"Premium" |
++ |
"Standard" |
++ |
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, NamespacesEventhub_STATUS, NamespacesEventhubsAuthorizationRule_STATUS, NamespacesEventhubsConsumerGroup_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 + |
+
-(Appears on:SiteConfig) +(Appears on:GitHubActionConfiguration)
The IIS handler mappings used to define which handler processes HTTP requests with certain extension. -For example, it -is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.
+The GitHub action code configuration.
-arguments- -string - - |
-
- Arguments: Command-line arguments to be passed to the script processor. - |
-
-extension+ runtimeStackstring |
- Extension: Requests with this extension will be handled using the specified FastCGI application. +RuntimeStack: Runtime stack is used to determine the workflow file content for code base apps. |
-scriptProcessor+ runtimeVersionstring |
- ScriptProcessor: The absolute path to the FastCGI application. +RuntimeVersion: Runtime version is used to determine what build version to set in the workflow file. |
-(Appears on:SiteConfig_STATUS) +(Appears on:GitHubActionConfiguration_STATUS)
The IIS handler mappings used to define which handler processes HTTP requests with certain extension. -For example, it -is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.
+The GitHub action code configuration.
-arguments- -string - - |
-
- Arguments: Command-line arguments to be passed to the script processor. - |
-
-extension+ runtimeStackstring |
- Extension: Requests with this extension will be handled using the specified FastCGI application. +RuntimeStack: Runtime stack is used to determine the workflow file content for code base apps. |
-scriptProcessor+ runtimeVersionstring |
- ScriptProcessor: The absolute path to the FastCGI application. +RuntimeVersion: Runtime version is used to determine what build version to set in the workflow file. |
-(Appears on:Site_Spec) +(Appears on:SitesSourcecontrol_Spec)
SSL-enabled hostname.
+The GitHub action configuration.
-hostType+ codeConfiguration- -HostNameSslState_HostType + +GitHubActionCodeConfiguration |
- HostType: Indicates whether the hostname is a standard or repository hostname. - |
-
-name- -string - - |
-
- Name: Hostname. +CodeConfiguration: GitHub Action code configuration. |
-sslState+ containerConfiguration- -HostNameSslState_SslState + +GitHubActionContainerConfiguration |
- SslState: SSL type. - |
-
-thumbprint- -string - - |
-
- Thumbprint: SSL certificate thumbprint. +ContainerConfiguration: GitHub Action container configuration. |
-toUpdate+ generateWorkflowFilebool |
- ToUpdate: Set to GenerateWorkflowFile: Workflow option to determine whether the workflow file should be generated and written to the +repository. |
-virtualIP+ isLinux-string +bool |
- VirtualIP: Virtual IP address assigned to the hostname if IP based SSL is enabled. +IsLinux: This will help determine the workflow configuration to select. |
string alias)-(Appears on:HostNameSslState) -
-| Value | -Description | -
|---|---|
"Repository" |
-- |
"Standard" |
-- |
string alias)-(Appears on:HostNameSslState_STATUS) -
-| Value | -Description | -
|---|---|
"Repository" |
-- |
"Standard" |
-- |
-(Appears on:Site_STATUS) +(Appears on:SitesSourcecontrol_STATUS)
SSL-enabled hostname.
+The GitHub action configuration.
-hostType+ codeConfiguration- -HostNameSslState_HostType_STATUS + +GitHubActionCodeConfiguration_STATUS |
- HostType: Indicates whether the hostname is a standard or repository hostname. - |
-
-name- -string - - |
-
- Name: Hostname. +CodeConfiguration: GitHub Action code configuration. |
-sslState+ containerConfiguration- -HostNameSslState_SslState_STATUS + +GitHubActionContainerConfiguration_STATUS |
- SslState: SSL type. - |
-
-thumbprint- -string - - |
-
- Thumbprint: SSL certificate thumbprint. +ContainerConfiguration: GitHub Action container configuration. |
-toUpdate+ generateWorkflowFilebool |
- ToUpdate: Set to GenerateWorkflowFile: Workflow option to determine whether the workflow file should be generated and written to the +repository. |
-virtualIP+ isLinux-string +bool |
- VirtualIP: Virtual IP address assigned to the hostname if IP based SSL is enabled. +IsLinux: This will help determine the workflow configuration to select. |
string alias)-(Appears on:HostNameSslState) -
-| Value | -Description | -
|---|---|
"Disabled" |
-- |
"IpBasedEnabled" |
-- |
"SniEnabled" |
-- |
string alias)-(Appears on:HostNameSslState_STATUS) -
-| Value | -Description | -
|---|---|
"Disabled" |
-- |
"IpBasedEnabled" |
-- |
"SniEnabled" |
-- |
-(Appears on:ServerFarm_Spec, Site_Spec) +(Appears on:GitHubActionConfiguration)
Specification for an App Service Environment to use for this resource.
+The GitHub action container configuration.
-reference+ imageName- -genruntime.ResourceReference +string + + |
+
+ ImageName: The image name for the build. + |
+
+password+ + +genruntime.SecretReference |
- Reference: Resource ID of the App Service Environment. +Password: The password used to upload the image to the container registry. + |
+
+serverUrl+ +string + + |
+
+ ServerUrl: The server URL for the container registry where the build will be hosted. + |
+
+username+ +string + + |
+
+ Username: The username used to upload the image to the container registry. |
-(Appears on:ServerFarm_STATUS, Site_STATUS) +(Appears on:GitHubActionConfiguration_STATUS)
Specification for an App Service Environment to use for this resource.
+The GitHub action container configuration.
-id+ imageNamestring |
- Id: Resource ID of the App Service Environment. +ImageName: The image name for the build. |
-name+ serverUrlstring |
- Name: Name of the App Service Environment. +ServerUrl: The server URL for the container registry where the build will be hosted. |
-type+ usernamestring |
- Type: Resource type of the App Service Environment. +Username: The username used to upload the image to the container registry. |
(Appears on:SiteConfig)
IP security restriction on an app.
+The IIS handler mappings used to define which handler processes HTTP requests with certain extension. +For example, it +is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.
-action+ argumentsstring |
- Action: Allow or Deny access for this IP range. - |
-
-description- -string - - |
-
- Description: IP restriction rule description. - |
-
-headers- -map[string][]string - - |
-
- Headers: IP restriction rule headers. -X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). -The matching logic is .. -- If the property is null or empty (default), all hosts(or lack of) are allowed. -- A value is compared using ordinal-ignore-case (excluding port number). -- Subdomain wildcards are permitted but don’t match the root domain. For example, *.contoso.com matches the subdomain -foo.contoso.com -but not the root domain contoso.com or multi-level foo.bar.contoso.com -- Unicode host names are allowed but are converted to Punycode for matching. -X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). -The matching logic is .. -- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. -- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. -X-Azure-FDID and X-FD-HealthProbe. -The matching logic is exact match. - |
-
-ipAddress- -string - - |
-
- IpAddress: IP address the security restriction is valid for. -It can be in form of pure ipv4 address (required SubnetMask property) or -CIDR notation such as ipv4/mask (leading bit match). For CIDR, -SubnetMask property must not be specified. +Arguments: Command-line arguments to be passed to the script processor. |
-name+ extensionstring |
- Name: IP restriction rule name. - |
-
-priority- -int - - |
-
- Priority: Priority of IP restriction rule. +Extension: Requests with this extension will be handled using the specified FastCGI application. |
-subnetMask+ scriptProcessorstring |
- SubnetMask: Subnet mask for the range of IP addresses the restriction is valid for. - |
-
-subnetTrafficTag- -int - - |
-
- SubnetTrafficTag: (internal) Subnet traffic tag - |
-
-tag- - -IpSecurityRestriction_Tag - - - |
-
- Tag: Defines what this IP filter will be used for. This is to support IP filtering on proxies. - |
-
-vnetSubnetResourceReference- - -genruntime.ResourceReference - - - |
-
- VnetSubnetResourceReference: Virtual network resource id - |
-
-vnetTrafficTag- -int - - |
-
- VnetTrafficTag: (internal) Vnet traffic tag +ScriptProcessor: The absolute path to the FastCGI application. |
(Appears on:SiteConfig_STATUS)
IP security restriction on an app.
+The IIS handler mappings used to define which handler processes HTTP requests with certain extension. +For example, it +is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.
-action+ argumentsstring |
- Action: Allow or Deny access for this IP range. +Arguments: Command-line arguments to be passed to the script processor. |
-description+ extensionstring |
- Description: IP restriction rule description. - |
-
-headers- -map[string][]string - - |
-
- Headers: IP restriction rule headers. -X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). -The matching logic is .. -- If the property is null or empty (default), all hosts(or lack of) are allowed. -- A value is compared using ordinal-ignore-case (excluding port number). -- Subdomain wildcards are permitted but don’t match the root domain. For example, *.contoso.com matches the subdomain -foo.contoso.com -but not the root domain contoso.com or multi-level foo.bar.contoso.com -- Unicode host names are allowed but are converted to Punycode for matching. -X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). -The matching logic is .. -- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. -- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. -X-Azure-FDID and X-FD-HealthProbe. -The matching logic is exact match. +Extension: Requests with this extension will be handled using the specified FastCGI application. |
-ipAddress+ scriptProcessorstring |
- IpAddress: IP address the security restriction is valid for. -It can be in form of pure ipv4 address (required SubnetMask property) or -CIDR notation such as ipv4/mask (leading bit match). For CIDR, -SubnetMask property must not be specified. +ScriptProcessor: The absolute path to the FastCGI application. |
+(Appears on:Site_Spec) +
+SSL-enabled hostname.
+
-name- -string - - |
-
- Name: IP restriction rule name. - |
+Field | +Description |
|---|---|---|---|
-priority+ hostType-int + +HostNameSslState_HostType + |
- Priority: Priority of IP restriction rule. +HostType: Indicates whether the hostname is a standard or repository hostname. |
||
-subnetMask+ namestring |
- SubnetMask: Subnet mask for the range of IP addresses the restriction is valid for. +Name: Hostname. |
||
-subnetTrafficTag+ sslState-int + +HostNameSslState_SslState + |
- SubnetTrafficTag: (internal) Subnet traffic tag +SslState: SSL type. |
||
-tag+ thumbprint- -IpSecurityRestriction_Tag_STATUS - +string |
- Tag: Defines what this IP filter will be used for. This is to support IP filtering on proxies. +Thumbprint: SSL certificate thumbprint. |
||
-vnetSubnetResourceId+ toUpdate-string +bool |
- VnetSubnetResourceId: Virtual network resource id +ToUpdate: Set to |
||
-vnetTrafficTag+ virtualIP-int +string |
- VnetTrafficTag: (internal) Vnet traffic tag +VirtualIP: Virtual IP address assigned to the hostname if IP based SSL is enabled. |
string alias)-(Appears on:IpSecurityRestriction) +(Appears on:HostNameSslState)
"Default"
"ServiceTag"
"Repository"
"XffProxy"
"Standard"
string alias)-(Appears on:IpSecurityRestriction_STATUS) +(Appears on:HostNameSslState_STATUS)
"Default"
"ServiceTag"
"Repository"
"XffProxy"
"Standard"
-(Appears on:ServerFarm_Spec) +(Appears on:Site_STATUS)
Specification for a Kubernetes Environment to use for this resource.
+SSL-enabled hostname.
-reference+ hostType- -genruntime.ResourceReference + +HostNameSslState_HostType_STATUS |
- Reference: Resource ID of the Kubernetes Environment. - |
-
-(Appears on:ServerFarm_STATUS) -
-Specification for a Kubernetes Environment to use for this resource.
-| Field | -Description | -
|---|---|
-id- -string - - |
-
- Id: Resource ID of the Kubernetes Environment. +HostType: Indicates whether the hostname is a standard or repository hostname. |
|
- Name: Name of the Kubernetes Environment. - |
-|
-type- -string - - |
-
- Type: Resource type of the Kubernetes Environment. - |
-
-(Appears on:Site_Spec) -
-Managed service identity.
-| Field | -Description | -
|---|---|
-type- - -ManagedServiceIdentity_Type - - - |
-
- Type: Type of managed service identity. +Name: Hostname. |
-userAssignedIdentities+ sslState- -[]UserAssignedIdentityDetails + +HostNameSslState_SslState_STATUS |
- UserAssignedIdentities: The list of user assigned 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:Site_STATUS) -
-Managed service identity.
-| Field | -Description | -
|---|---|
-principalId- -string - - |
-
- PrincipalId: Principal Id of managed service identity. +SslState: SSL type. |
-tenantId+ thumbprintstring |
- TenantId: Tenant of managed service identity. +Thumbprint: SSL certificate thumbprint. |
-type+ toUpdate- -ManagedServiceIdentity_Type_STATUS - +bool |
- Type: Type of managed service identity. +ToUpdate: Set to |
-userAssignedIdentities+ virtualIP- -map[string]./api/web/v1api20220301.UserAssignedIdentity_STATUS - +string |
- UserAssignedIdentities: The list of user assigned 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} + VirtualIP: Virtual IP address assigned to the hostname if IP based SSL is enabled. |
string alias)-(Appears on:ManagedServiceIdentity) +(Appears on:HostNameSslState)
"None"
"SystemAssigned"
"Disabled"
"SystemAssigned, UserAssigned"
"IpBasedEnabled"
"UserAssigned"
"SniEnabled"
string alias)-(Appears on:ManagedServiceIdentity_STATUS) +(Appears on:HostNameSslState_STATUS)
"None"
"SystemAssigned"
"Disabled"
"SystemAssigned, UserAssigned"
"IpBasedEnabled"
"UserAssigned"
"SniEnabled"
-(Appears on:SiteConfig) +(Appears on:ServerFarm_Spec, Site_Spec)
Name value pair.
+Specification for an App Service Environment to use for this resource.
-name- -string - - |
-
- Name: Pair name. - |
-
-value+ reference-string + +genruntime.ResourceReference + |
- Value: Pair value. +Reference: Resource ID of the App Service Environment. |
-(Appears on:SiteConfig_STATUS) +(Appears on:ServerFarm_STATUS, Site_STATUS)
Name value pair.
+Specification for an App Service Environment to use for this resource.
+id+ +string + + |
+
+ Id: Resource ID of the App Service Environment. + |
+
namestring |
- Name: Pair name. +Name: Name of the App Service Environment. |
-value+ typestring |
- Value: Pair value. +Type: Resource type of the App Service Environment. |
(Appears on:SiteConfig)
Push settings for the App.
+IP security restriction on an app.
-dynamicTagsJson+ actionstring |
- DynamicTagsJson: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in -the push registration endpoint. +Action: Allow or Deny access for this IP range. |
-isPushEnabled+ description-bool +string |
- IsPushEnabled: Gets or sets a flag indicating whether the Push endpoint is enabled. +Description: IP restriction rule description. |
-kind+ headers-string +map[string][]string |
- Kind: Kind of resource. +Headers: IP restriction rule headers. +X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). +The matching logic is .. +- If the property is null or empty (default), all hosts(or lack of) are allowed. +- A value is compared using ordinal-ignore-case (excluding port number). +- Subdomain wildcards are permitted but don’t match the root domain. For example, *.contoso.com matches the subdomain +foo.contoso.com +but not the root domain contoso.com or multi-level foo.bar.contoso.com +- Unicode host names are allowed but are converted to Punycode for matching. +X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). +The matching logic is .. +- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. +- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. +X-Azure-FDID and X-FD-HealthProbe. +The matching logic is exact match. |
-tagWhitelistJson+ ipAddressstring |
- TagWhitelistJson: Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push -registration endpoint. +IpAddress: IP address the security restriction is valid for. +It can be in form of pure ipv4 address (required SubnetMask property) or +CIDR notation such as ipv4/mask (leading bit match). For CIDR, +SubnetMask property must not be specified. |
-tagsRequiringAuth- -string - - |
-
- TagsRequiringAuth: Gets or sets a JSON string containing a list of tags that require user authentication to be used in -the push registration endpoint. -Tags can consist of alphanumeric characters and the following: -‘_’, ‘@’, ‘#’, ‘.’, ‘:’, ‘-’. -Validation should be performed at the PushRequestHandler. - |
-
-(Appears on:SiteConfig_STATUS) -
-Push settings for the App.
-| Field | -Description | -
|---|---|
-dynamicTagsJson- -string - - |
-
- DynamicTagsJson: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in -the push registration endpoint. - |
-
-id+ namestring |
- Id: Resource Id. +Name: IP restriction rule name. |
-isPushEnabled+ priority-bool +int |
- IsPushEnabled: Gets or sets a flag indicating whether the Push endpoint is enabled. +Priority: Priority of IP restriction rule. |
-kind+ subnetMaskstring |
- Kind: Kind of resource. +SubnetMask: Subnet mask for the range of IP addresses the restriction is valid for. |
-name+ subnetTrafficTag-string +int |
- Name: Resource Name. +SubnetTrafficTag: (internal) Subnet traffic tag |
-tagWhitelistJson+ tag-string + +IpSecurityRestriction_Tag + |
- TagWhitelistJson: Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push -registration endpoint. +Tag: Defines what this IP filter will be used for. This is to support IP filtering on proxies. |
-tagsRequiringAuth+ vnetSubnetResourceReference-string + +genruntime.ResourceReference + |
- TagsRequiringAuth: Gets or sets a JSON string containing a list of tags that require user authentication to be used in -the push registration endpoint. -Tags can consist of alphanumeric characters and the following: -‘_’, ‘@’, ‘#’, ‘.’, ‘:’, ‘-’. -Validation should be performed at the PushRequestHandler. +VnetSubnetResourceReference: Virtual network resource id |
-type+ vnetTrafficTag-string +int |
- Type: Resource type. +VnetTrafficTag: (internal) Vnet traffic tag |
-(Appears on:Experiments) +(Appears on:SiteConfig_STATUS)
Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change -routing % based on performance.
+IP security restriction on an app.
-actionHostName+ actionstring |
- ActionHostName: Hostname of a slot to which the traffic will be redirected if decided to. E.g. -myapp-stage.azurewebsites.net. +Action: Allow or Deny access for this IP range. |
-changeDecisionCallbackUrl+ descriptionstring |
- ChangeDecisionCallbackUrl: Custom decision algorithm can be provided in TiPCallback site extension which URL can be -specified. See TiPCallback site extension for the scaffold and contracts. -https://www.siteextensions.net/packages/TiPCallback/ +Description: IP restriction rule description. |
-changeIntervalInMinutes+ headers-int +map[string][]string |
- ChangeIntervalInMinutes: Specifies interval in minutes to reevaluate ReroutePercentage. +Headers: IP restriction rule headers. +X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). +The matching logic is .. +- If the property is null or empty (default), all hosts(or lack of) are allowed. +- A value is compared using ordinal-ignore-case (excluding port number). +- Subdomain wildcards are permitted but don’t match the root domain. For example, *.contoso.com matches the subdomain +foo.contoso.com +but not the root domain contoso.com or multi-level foo.bar.contoso.com +- Unicode host names are allowed but are converted to Punycode for matching. +X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). +The matching logic is .. +- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. +- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. +X-Azure-FDID and X-FD-HealthProbe. +The matching logic is exact match. |
-changeStep+ ipAddress-float64 +string |
- ChangeStep: In auto ramp up scenario this is the step to add/remove from IpAddress: IP address the security restriction is valid for. +It can be in form of pure ipv4 address (required SubnetMask property) or +CIDR notation such as ipv4/mask (leading bit match). For CIDR, +SubnetMask property must not be specified. |
-maxReroutePercentage+ name-float64 +string |
- MaxReroutePercentage: Specifies upper boundary below which ReroutePercentage will stay. +Name: IP restriction rule name. |
-minReroutePercentage+ priority-float64 +int |
- MinReroutePercentage: Specifies lower boundary above which ReroutePercentage will stay. +Priority: Priority of IP restriction rule. |
-name+ subnetMaskstring |
- Name: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the -experiment. +SubnetMask: Subnet mask for the range of IP addresses the restriction is valid for. |
-reroutePercentage+ subnetTrafficTag-float64 +int |
- ReroutePercentage: Percentage of the traffic which will be redirected to SubnetTrafficTag: (internal) Subnet traffic tag |
-(Appears on:Experiments_STATUS) -
-Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change -routing % based on performance.
-| Field | -Description | -
|---|---|
-actionHostName+ tag-string + +IpSecurityRestriction_Tag_STATUS + |
- ActionHostName: Hostname of a slot to which the traffic will be redirected if decided to. E.g. -myapp-stage.azurewebsites.net. +Tag: Defines what this IP filter will be used for. This is to support IP filtering on proxies. |
-changeDecisionCallbackUrl+ vnetSubnetResourceIdstring |
- ChangeDecisionCallbackUrl: Custom decision algorithm can be provided in TiPCallback site extension which URL can be -specified. See TiPCallback site extension for the scaffold and contracts. -https://www.siteextensions.net/packages/TiPCallback/ +VnetSubnetResourceId: Virtual network resource id |
-changeIntervalInMinutes+ vnetTrafficTagint |
- ChangeIntervalInMinutes: Specifies interval in minutes to reevaluate ReroutePercentage. +VnetTrafficTag: (internal) Vnet traffic tag |
string alias)+(Appears on:IpSecurityRestriction) +
+
-changeStep- -float64 - - |
-
- ChangeStep: In auto ramp up scenario this is the step to add/remove from |
+Value | +Description |
|---|---|---|---|
"Default" |
++ | ||
"ServiceTag" |
++ | ||
"XffProxy" |
++ |
string alias)+(Appears on:IpSecurityRestriction_STATUS) +
+
-maxReroutePercentage- -float64 - - |
-
- MaxReroutePercentage: Specifies upper boundary below which ReroutePercentage will stay. - |
-||
-minReroutePercentage- -float64 - - |
-
- MinReroutePercentage: Specifies lower boundary above which ReroutePercentage will stay. - |
+Value | +Description |
|---|---|---|---|
"Default" |
++ | ||
"ServiceTag" |
++ | ||
"XffProxy" |
++ |
+(Appears on:ServerFarm_Spec) +
+Specification for a Kubernetes Environment to use for this resource.
+
-name- -string - - |
-
- Name: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the -experiment. - |
+Field | +Description |
|---|---|---|---|
-reroutePercentage+ reference-float64 + +genruntime.ResourceReference + |
- ReroutePercentage: Percentage of the traffic which will be redirected to Reference: Resource ID of the Kubernetes Environment. |
-(Appears on:AutoHealTriggers) +(Appears on:ServerFarm_STATUS)
Trigger based on total requests.
+Specification for a Kubernetes Environment to use for this resource.
-count+ id-int +string |
- Count: Request Count. +Id: Resource ID of the Kubernetes Environment. |
-timeInterval+ namestring |
- TimeInterval: Time interval. +Name: Name of the Kubernetes Environment. + |
+
+type+ +string + + |
+
+ Type: Resource type of the Kubernetes Environment. |
-(Appears on:AutoHealTriggers_STATUS) +(Appears on:Site_Spec)
Trigger based on total requests.
+Managed service identity.
-count+ type-int + +ManagedServiceIdentity_Type + |
- Count: Request Count. +Type: Type of managed service identity. |
-timeInterval+ userAssignedIdentities-string + +[]UserAssignedIdentityDetails + |
- TimeInterval: Time interval. +UserAssignedIdentities: The list of user assigned 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:Site_STATUS) +
Generator information: -- Generated from: /web/resource-manager/Microsoft.Web/stable/2022-03-01/AppServicePlans.json -- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name} +
Managed service identity.
-metadata+ principalId- -Kubernetes meta/v1.ObjectMeta - +string |
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+PrincipalId: Principal Id of managed service identity. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
-spec- - -ServerFarm_Spec - - - |
-
- - -
ManagedServiceIdentity_Type
+(
+ |
-freeOfferExpirationTime- -string - - |
-
- FreeOfferExpirationTime: The time when the server farm free offer expires. - |
+Value | +Description | +
|---|---|---|---|
"None" |
++ | ||
"SystemAssigned" |
++ | ||
"SystemAssigned, UserAssigned" |
++ | ||
"UserAssigned" |
++ |
string alias)+(Appears on:ManagedServiceIdentity_STATUS) +
+| Value | +Description |
|---|---|
"None" |
++ |
"SystemAssigned" |
++ |
"SystemAssigned, UserAssigned" |
++ |
"UserAssigned" |
++ |
+(Appears on:SiteConfig) +
+Name value pair.
+
-hostingEnvironmentProfile- - -HostingEnvironmentProfile - - - |
-
- HostingEnvironmentProfile: Specification for the App Service Environment to use for the App Service plan. - |
+Field | +Description |
|---|---|---|---|
-hyperV+ name-bool +string |
- HyperV: If Hyper-V container app service plan Name: Pair name. |
||
-isSpot+ value-bool +string |
- IsSpot: If Value: Pair value. |
||
-isXenon- -bool - - |
-
- IsXenon: Obsolete: If Hyper-V container app service plan |
+
+(Appears on:SiteConfig_STATUS) +
+Name value pair.
+| Field | +Description |
|---|---|
-kind+ namestring |
- Kind: Kind of resource. +Name: Pair name. |
-kubeEnvironmentProfile+ value- -KubeEnvironmentProfile - +string |
- KubeEnvironmentProfile: Specification for the Kubernetes Environment to use for the App Service plan. +Value: Pair value. |
+(Appears on:SiteConfig) +
+Push settings for the App.
+| Field | +Description | +
|---|---|
-location+ dynamicTagsJsonstring |
- Location: Resource Location. +DynamicTagsJson: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in +the push registration endpoint. |
-maximumElasticWorkerCount+ isPushEnabled-int +bool |
- MaximumElasticWorkerCount: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan +IsPushEnabled: Gets or sets a flag indicating whether the Push endpoint is enabled. |
-operatorSpec+ kind- -ServerFarmOperatorSpec - +string |
- OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not -passed directly to Azure +Kind: Kind of resource. |
-owner+ tagWhitelistJson- -genruntime.KnownResourceReference - +string |
- 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 +TagWhitelistJson: Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push +registration endpoint. |
-perSiteScaling+ tagsRequiringAuth-bool +string |
- PerSiteScaling: If TagsRequiringAuth: Gets or sets a JSON string containing a list of tags that require user authentication to be used in +the push registration endpoint. +Tags can consist of alphanumeric characters and the following: +‘_’, ‘@’, ‘#’, ‘.’, ‘:’, ‘-’. +Validation should be performed at the PushRequestHandler. |
+(Appears on:SiteConfig_STATUS) +
+Push settings for the App.
+
-reserved- -bool - - |
-
- Reserved: If Linux app service plan |
+Field | +Description |
|---|---|---|---|
-sku+ dynamicTagsJson- -SkuDescription - +string |
- Sku: Description of a SKU for a scalable resource. +DynamicTagsJson: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in +the push registration endpoint. |
||
-spotExpirationTime+ idstring |
- SpotExpirationTime: The time when the server farm expires. Valid only if it is a spot server farm. +Id: Resource Id. |
||
-tags+ isPushEnabled-map[string]string +bool |
- Tags: Resource tags. +IsPushEnabled: Gets or sets a flag indicating whether the Push endpoint is enabled. |
||
-targetWorkerCount+ kind-int +string |
- TargetWorkerCount: Scaling worker count. +Kind: Kind of resource. |
||
-targetWorkerSizeId+ name-int +string |
- TargetWorkerSizeId: Scaling worker size ID. +Name: Resource Name. |
||
-workerTierName+ tagWhitelistJsonstring |
- WorkerTierName: Target worker tier assigned to the App Service plan. +TagWhitelistJson: Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push +registration endpoint. |
||
-zoneRedundant+ tagsRequiringAuth-bool +string |
- ZoneRedundant: If |
-
TagsRequiringAuth: Gets or sets a JSON string containing a list of tags that require user authentication to be used in +the push registration endpoint. +Tags can consist of alphanumeric characters and the following: +‘_’, ‘@’, ‘#’, ‘.’, ‘:’, ‘-’. +Validation should be performed at the PushRequestHandler.
statustypeType: Resource type.
-(Appears on:ServerFarm_Spec) +(Appears on:Experiments)
Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change +routing % based on performance.
-configMapExpressions+ actionHostName- -[]genruntime/core.DestinationExpression - +string |
- ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). +ActionHostName: Hostname of a slot to which the traffic will be redirected if decided to. E.g. +myapp-stage.azurewebsites.net. |
-secretExpressions+ changeDecisionCallbackUrl- -[]genruntime/core.DestinationExpression - +string |
- SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). +ChangeDecisionCallbackUrl: Custom decision algorithm can be provided in TiPCallback site extension which URL can be +specified. See TiPCallback site extension for the scaffold and contracts. +https://www.siteextensions.net/packages/TiPCallback/ |
-(Appears on:ServerFarm) -
-| Field | -Description | -
|---|---|
-conditions+ changeIntervalInMinutes- -[]genruntime/conditions.Condition - +int |
- Conditions: The observed state of the resource +ChangeIntervalInMinutes: Specifies interval in minutes to reevaluate ReroutePercentage. |
-elasticScaleEnabled+ changeStep-bool +float64 |
- ElasticScaleEnabled: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was -ElasticPremium sku +ChangeStep: In auto ramp up scenario this is the step to add/remove from |
-extendedLocation+ maxReroutePercentage- -ExtendedLocation_STATUS - +float64 |
- ExtendedLocation: Extended Location. +MaxReroutePercentage: Specifies upper boundary below which ReroutePercentage will stay. |
-freeOfferExpirationTime+ minReroutePercentage-string +float64 |
- FreeOfferExpirationTime: The time when the server farm free offer expires. +MinReroutePercentage: Specifies lower boundary above which ReroutePercentage will stay. |
-geoRegion+ namestring |
- GeoRegion: Geographical location for the App Service plan. +Name: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the +experiment. |
-hostingEnvironmentProfile+ reroutePercentage- -HostingEnvironmentProfile_STATUS - +float64 |
- HostingEnvironmentProfile: Specification for the App Service Environment to use for the App Service plan. +ReroutePercentage: Percentage of the traffic which will be redirected to |
+(Appears on:Experiments_STATUS) +
+Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change +routing % based on performance.
+| Field | +Description | +
|---|---|
-hyperV+ actionHostName-bool +string |
- HyperV: If Hyper-V container app service plan ActionHostName: Hostname of a slot to which the traffic will be redirected if decided to. E.g. +myapp-stage.azurewebsites.net. |
-id+ changeDecisionCallbackUrlstring |
- Id: Resource Id. +ChangeDecisionCallbackUrl: Custom decision algorithm can be provided in TiPCallback site extension which URL can be +specified. See TiPCallback site extension for the scaffold and contracts. +https://www.siteextensions.net/packages/TiPCallback/ |
-isSpot+ changeIntervalInMinutes-bool +int |
- IsSpot: If ChangeIntervalInMinutes: Specifies interval in minutes to reevaluate ReroutePercentage. |
-isXenon+ changeStep-bool +float64 |
- IsXenon: Obsolete: If Hyper-V container app service plan ChangeStep: In auto ramp up scenario this is the step to add/remove from |
-kind+ maxReroutePercentage-string +float64 |
- Kind: Kind of resource. +MaxReroutePercentage: Specifies upper boundary below which ReroutePercentage will stay. |
-kubeEnvironmentProfile+ minReroutePercentage- -KubeEnvironmentProfile_STATUS - +float64 |
- KubeEnvironmentProfile: Specification for the Kubernetes Environment to use for the App Service plan. +MinReroutePercentage: Specifies lower boundary above which ReroutePercentage will stay. |
-location+ namestring |
- Location: Resource Location. +Name: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the +experiment. |
-maximumElasticWorkerCount+ reroutePercentage-int +float64 |
- MaximumElasticWorkerCount: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan +ReroutePercentage: Percentage of the traffic which will be redirected to |
+(Appears on:AutoHealTriggers) +
+Trigger based on total requests.
+| Field | +Description | +
|---|---|
-maximumNumberOfWorkers+ countint |
- MaximumNumberOfWorkers: Maximum number of instances that can be assigned to this App Service plan. +Count: Request Count. |
-name+ timeIntervalstring |
- Name: Resource Name. +TimeInterval: Time interval. |
+(Appears on:AutoHealTriggers_STATUS) +
+Trigger based on total requests.
+| Field | +Description | +
|---|---|
-numberOfSites+ countint |
- NumberOfSites: Number of apps assigned to this App Service plan. +Count: Request Count. |
-numberOfWorkers+ timeInterval-int +string |
- NumberOfWorkers: The number of instances that are assigned to this App Service plan. +TimeInterval: Time interval. |
Generator information: +- Generated from: /web/resource-manager/Microsoft.Web/stable/2022-03-01/AppServicePlans.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name} +
| Field | +Description | +||
|---|---|---|---|
-perSiteScaling+ metadata-bool + +Kubernetes meta/v1.ObjectMeta + |
- PerSiteScaling: If metadata field.
|
||
-provisioningState+ spec- -Serverfarm_Properties_ProvisioningState_STATUS + +ServerFarm_Spec |
- ProvisioningState: Provisioning state of the App Service Plan. - |
-
-reserved+ azureName-bool +string |
- Reserved: If Linux app service plan 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. |
-resourceGroup+ elasticScaleEnabled-string +bool |
- ResourceGroup: Resource group of the App Service plan. +ElasticScaleEnabled: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was +ElasticPremium sku |
-sku+ extendedLocation- -SkuDescription_STATUS + +ExtendedLocation |
- Sku: Description of a SKU for a scalable resource. +ExtendedLocation: Extended Location. |
-spotExpirationTime+ freeOfferExpirationTimestring |
- SpotExpirationTime: The time when the server farm expires. Valid only if it is a spot server farm. +FreeOfferExpirationTime: The time when the server farm free offer expires. |
-status+ hostingEnvironmentProfile- -Serverfarm_Properties_Status_STATUS + +HostingEnvironmentProfile |
- Status: App Service plan status. +HostingEnvironmentProfile: Specification for the App Service Environment to use for the App Service plan. |
-subscription+ hyperV-string +bool |
- Subscription: App Service plan subscription. +HyperV: If Hyper-V container app service plan |
-tags+ isSpot-map[string]string +bool |
- Tags: Resource tags. +IsSpot: If |
-targetWorkerCount+ isXenon-int +bool |
- TargetWorkerCount: Scaling worker count. +IsXenon: Obsolete: If Hyper-V container app service plan |
-targetWorkerSizeId+ kind-int +string |
- TargetWorkerSizeId: Scaling worker size ID. +Kind: Kind of resource. |
-type+ kubeEnvironmentProfile-string + +KubeEnvironmentProfile + |
- Type: Resource type. +KubeEnvironmentProfile: Specification for the Kubernetes Environment to use for the App Service plan. |
-workerTierName+ locationstring |
- WorkerTierName: Target worker tier assigned to the App Service plan. +Location: Resource Location. |
-zoneRedundant+ maximumElasticWorkerCount-bool +int |
- ZoneRedundant: If MaximumElasticWorkerCount: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan |
-(Appears on:ServerFarm) -
-| Field | -Description | +
+operatorSpec+ + +ServerFarmOperatorSpec + + + |
+
+ OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure + |
|---|---|---|---|
-azureName+ owner-string + +genruntime.KnownResourceReference + |
- 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. +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 |
||
-elasticScaleEnabled+ perSiteScalingbool |
- ElasticScaleEnabled: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was -ElasticPremium sku +PerSiteScaling: If |
||
-extendedLocation+ reserved- -ExtendedLocation - +bool |
- ExtendedLocation: Extended Location. +Reserved: If Linux app service plan |
||
-freeOfferExpirationTime+ sku-string + +SkuDescription + |
- FreeOfferExpirationTime: The time when the server farm free offer expires. +Sku: Description of a SKU for a scalable resource. |
||
-hostingEnvironmentProfile+ spotExpirationTime- -HostingEnvironmentProfile - +string |
- HostingEnvironmentProfile: Specification for the App Service Environment to use for the App Service plan. +SpotExpirationTime: The time when the server farm expires. Valid only if it is a spot server farm. |
||
-hyperV+ tags-bool +map[string]string |
- HyperV: If Hyper-V container app service plan Tags: Resource tags. |
||
-isSpot+ targetWorkerCount-bool +int |
- IsSpot: If TargetWorkerCount: Scaling worker count. |
||
-isXenon+ targetWorkerSizeId-bool +int |
- IsXenon: Obsolete: If Hyper-V container app service plan TargetWorkerSizeId: Scaling worker size ID. |
||
-kind+ workerTierNamestring |
- Kind: Kind of resource. +WorkerTierName: Target worker tier assigned to the App Service plan. |
||
-kubeEnvironmentProfile+ zoneRedundant- -KubeEnvironmentProfile - +bool |
- KubeEnvironmentProfile: Specification for the Kubernetes Environment to use for the App Service plan. +ZoneRedundant: If |
+
locationstatusLocation: Resource Location.
+(Appears on:ServerFarm_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
-maximumElasticWorkerCount+ configMapExpressions-int + +[]genruntime/core.DestinationExpression + |
- MaximumElasticWorkerCount: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan +ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
-operatorSpec+ secretExpressions- -ServerFarmOperatorSpec + +[]genruntime/core.DestinationExpression |
- OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not -passed directly to Azure +SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
+(Appears on:ServerFarm) +
+| Field | +Description | +
|---|---|
-owner+ conditions- -genruntime.KnownResourceReference + +[]genruntime/conditions.Condition |
- 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 +Conditions: The observed state of the resource |
-perSiteScaling+ elasticScaleEnabledbool |
- PerSiteScaling: If ElasticScaleEnabled: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was +ElasticPremium sku |
-reserved+ extendedLocation-bool + +ExtendedLocation_STATUS + |
- Reserved: If Linux app service plan ExtendedLocation: Extended Location. |
-sku+ freeOfferExpirationTime- -SkuDescription - +string |
- Sku: Description of a SKU for a scalable resource. +FreeOfferExpirationTime: The time when the server farm free offer expires. |
-spotExpirationTime+ geoRegionstring |
- SpotExpirationTime: The time when the server farm expires. Valid only if it is a spot server farm. +GeoRegion: Geographical location for the App Service plan. |
-tags+ hostingEnvironmentProfile-map[string]string + +HostingEnvironmentProfile_STATUS + |
- Tags: Resource tags. +HostingEnvironmentProfile: Specification for the App Service Environment to use for the App Service plan. |
-targetWorkerCount+ hyperV-int +bool |
- TargetWorkerCount: Scaling worker count. +HyperV: If Hyper-V container app service plan |
-targetWorkerSizeId+ id-int +string |
- TargetWorkerSizeId: Scaling worker size ID. +Id: Resource Id. |
-workerTierName+ isSpot-string +bool |
- WorkerTierName: Target worker tier assigned to the App Service plan. +IsSpot: If |
-zoneRedundant+ isXenonbool |
- ZoneRedundant: If IsXenon: Obsolete: If Hyper-V container app service plan |
string alias)-(Appears on:ServerFarm_STATUS) -
-| Value | -Description | +
+kind+ +string + + |
+
+ Kind: Kind of resource. + |
|---|---|---|---|
"Canceled" |
-- | ||
"Deleting" |
-- | ||
"Failed" |
-- | ||
"InProgress" |
-- | ||
"Succeeded" |
-- |
string alias)-(Appears on:ServerFarm_STATUS) -
-| Value | -Description | -
|---|---|
"Creating" |
-- |
"Pending" |
-- |
"Ready" |
-- |
Generator information: -- Generated from: /web/resource-manager/Microsoft.Web/stable/2022-03-01/WebApps.json -- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name} -
| Field | -Description | -||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
-metadata+ kubeEnvironmentProfile- -Kubernetes meta/v1.ObjectMeta + +KubeEnvironmentProfile_STATUS |
-Refer to the Kubernetes API documentation for the fields of the
-metadata field.
+KubeEnvironmentProfile: Specification for the Kubernetes Environment to use for the App Service plan. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
-spec- - -Site_Spec - - - |
-
- - -
ServerFarm_Spec +++(Appears on:ServerFarm) + +
+
+
PerSiteScaling: If |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
-status+ reserved- -Site_STATUS - +bool |
+ Reserved: If Linux app service plan |
-(Appears on:Site_Spec) -
-Configuration of an App Service app.
-| Field | -Description | -
|---|---|
-acrUseManagedIdentityCreds+ sku-bool + +SkuDescription + |
- AcrUseManagedIdentityCreds: Flag to use Managed Identity Creds for ACR pull +Sku: Description of a SKU for a scalable resource. |
-acrUserManagedIdentityID+ spotExpirationTimestring |
- AcrUserManagedIdentityID: If using user managed identity, the user managed identity ClientId +SpotExpirationTime: The time when the server farm expires. Valid only if it is a spot server farm. |
-alwaysOn+ tags-bool +map[string]string |
- AlwaysOn: Tags: Resource tags. |
-apiDefinition+ targetWorkerCount- -ApiDefinitionInfo - +int |
- ApiDefinition: Information about the formal API definition for the app. +TargetWorkerCount: Scaling worker count. |
-apiManagementConfig+ targetWorkerSizeId- -ApiManagementConfig - +int |
- ApiManagementConfig: Azure API management settings linked to the app. +TargetWorkerSizeId: Scaling worker size ID. |
-appCommandLine+ workerTierNamestring |
- AppCommandLine: App command line to launch. +WorkerTierName: Target worker tier assigned to the App Service plan. |
-appSettings+ zoneRedundant- -[]NameValuePair - +bool |
- AppSettings: Application settings. +ZoneRedundant: If |
string alias)+(Appears on:ServerFarm_STATUS) +
+| Value | +Description | +
|---|---|
"Canceled" |
++ |
"Deleting" |
++ |
"Failed" |
++ |
"InProgress" |
++ |
"Succeeded" |
++ |
string alias)+(Appears on:ServerFarm_STATUS) +
+| Value | +Description | +
|---|---|
"Creating" |
++ |
"Pending" |
++ |
"Ready" |
++ |
Generator information: +- Generated from: /web/resource-manager/Microsoft.Web/stable/2022-03-01/WebApps.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name} +
| Field | +Description | +
|---|---|
-autoHealEnabled+ metadata-bool + +Kubernetes meta/v1.ObjectMeta + |
- AutoHealEnabled: metadata field.
|
-autoHealRules+ spec- -AutoHealRules + +Site_Spec |
- AutoHealRules: Auto Heal rules. - |
-
-autoSwapSlotName+ azureNamestring |
- AutoSwapSlotName: Auto-swap slot name. +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. |
-azureStorageAccounts+ clientAffinityEnabled- -map[string]./api/web/v1api20220301.AzureStorageInfoValue - +bool |
- AzureStorageAccounts: List of Azure Storage Accounts. - |
-
-connectionStrings- - -[]ConnStringInfo - - - |
-
- ConnectionStrings: Connection strings. +ClientAffinityEnabled: |
-cors+ clientCertEnabled- -CorsSettings - +bool |
- Cors: Cross-Origin Resource Sharing (CORS) settings. +ClientCertEnabled: |
-defaultDocuments+ clientCertExclusionPaths-[]string +string |
- DefaultDocuments: Default documents. +ClientCertExclusionPaths: client certificate authentication comma-separated exclusion paths |
-detailedErrorLoggingEnabled+ clientCertMode-bool + +Site_Properties_ClientCertMode_Spec + |
- DetailedErrorLoggingEnabled: ClientCertMode: This composes with ClientCertEnabled setting. +- ClientCertEnabled: false means ClientCert is ignored. +- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. +- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. |
-documentRoot+ cloningInfo-string + +CloningInfo + |
- DocumentRoot: Document root. +CloningInfo: If specified during app creation, the app is cloned from a source app. |
-experiments+ containerSize- -Experiments - +int |
- Experiments: This is work around for polymorphic types. +ContainerSize: Size of the function container. |
-ftpsState+ customDomainVerificationId- -SiteConfig_FtpsState - +string |
- FtpsState: State of FTP / FTPS service +CustomDomainVerificationId: Unique identifier that verifies the custom domains assigned to the app. Customer will add +this id to a txt record for verification. |
-functionAppScaleLimit+ dailyMemoryTimeQuotaint |
- FunctionAppScaleLimit: Maximum number of workers that a site can scale out to. -This setting only applies to the Consumption and Elastic Premium Plans +DailyMemoryTimeQuota: Maximum allowed daily memory-time quota (applicable on dynamic apps only). |
-functionsRuntimeScaleMonitoringEnabled+ enabledbool |
- FunctionsRuntimeScaleMonitoringEnabled: Gets or sets a value indicating whether functions runtime scale monitoring is -enabled. When enabled, -the ScaleController will not monitor event sources directly, but will instead call to the -runtime to get scale status. +Enabled: |
-handlerMappings+ extendedLocation- -[]HandlerMapping + +ExtendedLocation |
- HandlerMappings: Handler mappings. +ExtendedLocation: Extended Location. |
-healthCheckPath+ hostNameSslStates-string + +[]HostNameSslState + |
- HealthCheckPath: Health check path +HostNameSslStates: Hostname SSL states are used to manage the SSL bindings for app’s hostnames. |
-http20Enabled+ hostNamesDisabledbool |
- Http20Enabled: Http20Enabled: configures a web site to allow clients to connect over http2.0 +HostNamesDisabled: |
-httpLoggingEnabled+ hostingEnvironmentProfile-bool + +HostingEnvironmentProfile + |
- HttpLoggingEnabled: HostingEnvironmentProfile: App Service Environment to use for the app. |
-ipSecurityRestrictions+ httpsOnly- -[]IpSecurityRestriction - +bool |
- IpSecurityRestrictions: IP security restrictions for main. +HttpsOnly: HttpsOnly: configures a web site to accept only https requests. Issues redirect for +http requests |
-javaContainer+ hyperV-string +bool |
- JavaContainer: Java container. +HyperV: Hyper-V sandbox. |
-javaContainerVersion+ identity-string + +ManagedServiceIdentity + |
- JavaContainerVersion: Java container version. +Identity: Managed service identity. |
-javaVersion+ isXenon-string +bool |
- JavaVersion: Java version. +IsXenon: Obsolete: Hyper-V sandbox. |
-limits+ kind- -SiteLimits - +string |
- Limits: Site limits. +Kind: Kind of resource. |
-linuxFxVersion+ locationstring |
- LinuxFxVersion: Linux App Framework and version +Location: Resource Location. |
-loadBalancing+ operatorSpec- -SiteConfig_LoadBalancing + +SiteOperatorSpec |
- LoadBalancing: Site load balancing. +OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure |
-localMySqlEnabled+ owner-bool + +genruntime.KnownResourceReference + |
- LocalMySqlEnabled: 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 |
-logsDirectorySizeLimit+ publicNetworkAccess-int +string |
- LogsDirectorySizeLimit: HTTP logs directory size limit. +PublicNetworkAccess: Property to allow or block all public traffic. Allowed Values: ‘Enabled’, ‘Disabled’ or an empty +string. |
-managedPipelineMode+ redundancyMode- -SiteConfig_ManagedPipelineMode + +Site_Properties_RedundancyMode_Spec |
- ManagedPipelineMode: Managed pipeline mode. +RedundancyMode: Site redundancy mode |
-managedServiceIdentityId+ reserved-int +bool |
- ManagedServiceIdentityId: Managed Service Identity Id +Reserved: |
-minTlsVersion+ scmSiteAlsoStopped- -SiteConfig_MinTlsVersion - +bool |
- MinTlsVersion: MinTlsVersion: configures the minimum version of TLS required for SSL requests +ScmSiteAlsoStopped: |
-minimumElasticInstanceCount+ serverFarmReference-int + +genruntime.ResourceReference + |
- MinimumElasticInstanceCount: Number of minimum instance count for a site -This setting only applies to the Elastic Plans +ServerFarmReference: Resource ID of the associated App Service plan, formatted as: +“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”. |
-netFrameworkVersion+ siteConfig-string + +SiteConfig + |
- NetFrameworkVersion: .NET Framework version. +SiteConfig: Configuration of the app. |
-nodeVersion+ storageAccountRequired-string +bool |
- NodeVersion: Version of Node.js. +StorageAccountRequired: Checks if Customer provided storage account is required |
-numberOfWorkers+ tags-int +map[string]string |
- NumberOfWorkers: Number of workers. +Tags: Resource tags. |
-phpVersion+ virtualNetworkSubnetReference-string + +genruntime.ResourceReference + |
- PhpVersion: Version of PHP. +VirtualNetworkSubnetReference: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET +Integration. +This must be of the form +/subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} |
-powerShellVersion+ vnetContentShareEnabled-string +bool |
- PowerShellVersion: Version of PowerShell. +VnetContentShareEnabled: To enable accessing content over virtual network |
-preWarmedInstanceCount+ vnetImagePullEnabled-int +bool |
- PreWarmedInstanceCount: Number of preWarmed instances. -This setting only applies to the Consumption and Elastic Plans +VnetImagePullEnabled: To enable pulling image over Virtual Network |
-publicNetworkAccess+ vnetRouteAllEnabled-string +bool |
- PublicNetworkAccess: Property to allow or block all public traffic. +VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network +Security Groups and User Defined Routes applied. + |
+
publishingUsernamestatusPublishingUsername: Publishing user name.
+(Appears on:Site_Spec) +
+Configuration of an App Service app.
+| Field | +Description | +
|---|---|
-push+ acrUseManagedIdentityCreds- -PushSettings - +bool |
- Push: Push endpoint settings. +AcrUseManagedIdentityCreds: Flag to use Managed Identity Creds for ACR pull |
-pythonVersion+ acrUserManagedIdentityIDstring |
- PythonVersion: Version of Python. +AcrUserManagedIdentityID: If using user managed identity, the user managed identity ClientId |
-remoteDebuggingEnabled+ alwaysOnbool |
- RemoteDebuggingEnabled: AlwaysOn: |
-remoteDebuggingVersion+ apiDefinition-string + +ApiDefinitionInfo + |
- RemoteDebuggingVersion: Remote debugging version. +ApiDefinition: Information about the formal API definition for the app. |
-requestTracingEnabled+ apiManagementConfig-bool + +ApiManagementConfig + |
- RequestTracingEnabled: ApiManagementConfig: Azure API management settings linked to the app. |
-requestTracingExpirationTime+ appCommandLinestring |
- RequestTracingExpirationTime: Request tracing expiration time. +AppCommandLine: App command line to launch. |
-scmIpSecurityRestrictions+ appSettings- -[]IpSecurityRestriction + +[]NameValuePair |
- ScmIpSecurityRestrictions: IP security restrictions for scm. +AppSettings: Application settings. |
-scmIpSecurityRestrictionsUseMain+ autoHealEnabledbool |
- ScmIpSecurityRestrictionsUseMain: IP security restrictions for scm to use main. +AutoHealEnabled: |
-scmMinTlsVersion+ autoHealRules- -SiteConfig_ScmMinTlsVersion + +AutoHealRules |
- ScmMinTlsVersion: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site +AutoHealRules: Auto Heal rules. |
-scmType+ autoSwapSlotName- -SiteConfig_ScmType +string + + |
+
+ AutoSwapSlotName: Auto-swap slot name. + |
+
+azureStorageAccounts+ + +map[string]./api/web/v1api20220301.AzureStorageInfoValue |
- ScmType: SCM type. +AzureStorageAccounts: List of Azure Storage Accounts. |
-tracingOptions+ connectionStrings-string + +[]ConnStringInfo + |
- TracingOptions: Tracing options. +ConnectionStrings: Connection strings. |
-use32BitWorkerProcess+ cors+ + +CorsSettings + + + |
+
+ Cors: Cross-Origin Resource Sharing (CORS) settings. + |
+
+defaultDocuments+ +[]string + + |
+
+ DefaultDocuments: Default documents. + |
+
+detailedErrorLoggingEnabledbool |
- Use32BitWorkerProcess: DetailedErrorLoggingEnabled: |
-virtualApplications+ documentRoot- -[]VirtualApplication +string + + |
+
+ DocumentRoot: Document root. + |
+
+experiments+ + +Experiments |
- VirtualApplications: Virtual applications. +Experiments: This is work around for polymorphic types. |
-vnetName+ ftpsState-string + +SiteConfig_FtpsState + |
- VnetName: Virtual Network name. +FtpsState: State of FTP / FTPS service |
-vnetPrivatePortsCount+ functionAppScaleLimitint |
- VnetPrivatePortsCount: The number of private ports assigned to this app. These will be assigned dynamically on runtime. +FunctionAppScaleLimit: Maximum number of workers that a site can scale out to. +This setting only applies to the Consumption and Elastic Premium Plans |
-vnetRouteAllEnabled+ functionsRuntimeScaleMonitoringEnabledbool |
- VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network -Security Groups and User Defined Routes applied. +FunctionsRuntimeScaleMonitoringEnabled: Gets or sets a value indicating whether functions runtime scale monitoring is +enabled. When enabled, +the ScaleController will not monitor event sources directly, but will instead call to the +runtime to get scale status. |
-webSocketsEnabled+ handlerMappings-bool + +[]HandlerMapping + |
- WebSocketsEnabled: HandlerMappings: Handler mappings. |
-websiteTimeZone+ healthCheckPathstring |
- WebsiteTimeZone: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App -Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database -values https://www.iana.org/time-zones (for a quick reference see -https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under -HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones +HealthCheckPath: Health check path |
-windowsFxVersion+ http20Enabled-string +bool |
- WindowsFxVersion: Xenon App Framework and version +Http20Enabled: Http20Enabled: configures a web site to allow clients to connect over http2.0 |
-xManagedServiceIdentityId+ httpLoggingEnabled-int +bool |
- XManagedServiceIdentityId: Explicit Managed Service Identity Id +HttpLoggingEnabled: |
string alias)-(Appears on:SiteConfig) -
-| Value | -Description | +
+ipSecurityRestrictions+ + +[]IpSecurityRestriction + + + |
+
+ IpSecurityRestrictions: IP security restrictions for main. + |
|---|---|---|---|
"AllAllowed" |
-- | ||
"Disabled" |
-- | ||
"FtpsOnly" |
-- |
string alias)-(Appears on:SiteConfig_STATUS) -
-| Value | -Description | -
|---|---|
"AllAllowed" |
-- |
"Disabled" |
-- |
"FtpsOnly" |
-- |
string alias)-(Appears on:SiteConfig) -
-| Value | -Description | -
|---|---|
"LeastRequests" |
-- |
"LeastResponseTime" |
-- |
"PerSiteRoundRobin" |
-- |
"RequestHash" |
-- |
"WeightedRoundRobin" |
-- |
"WeightedTotalTraffic" |
-- |
string alias)-(Appears on:SiteConfig_STATUS) -
-| Value | -Description | -
|---|---|
"LeastRequests" |
-- |
"LeastResponseTime" |
-- |
"PerSiteRoundRobin" |
-- |
"RequestHash" |
-- |
"WeightedRoundRobin" |
-- |
"WeightedTotalTraffic" |
-- |
string alias)-(Appears on:SiteConfig) -
-| Value | -Description | -
|---|---|
"Classic" |
-- |
"Integrated" |
-- |
string alias)-(Appears on:SiteConfig_STATUS) -
-| Value | -Description | -
|---|---|
"Classic" |
-- |
"Integrated" |
-- |
string alias)-(Appears on:SiteConfig) -
-| Value | -Description | -
|---|---|
"1.0" |
-- |
"1.1" |
-- |
"1.2" |
-- |
string alias)-(Appears on:SiteConfig_STATUS) -
-| Value | -Description | -
|---|---|
"1.0" |
-- |
"1.1" |
-- |
"1.2" |
-- |
-(Appears on:Site_STATUS) -
-Configuration of an App Service app.
-| Field | -Description | -
|---|---|
-acrUseManagedIdentityCreds+ javaContainer-bool +string |
- AcrUseManagedIdentityCreds: Flag to use Managed Identity Creds for ACR pull +JavaContainer: Java container. |
-acrUserManagedIdentityID+ javaContainerVersionstring |
- AcrUserManagedIdentityID: If using user managed identity, the user managed identity ClientId +JavaContainerVersion: Java container version. |
-alwaysOn+ javaVersion-bool +string |
- AlwaysOn: JavaVersion: Java version. |
-apiDefinition+ keyVaultReferenceIdentity- -ApiDefinitionInfo_STATUS - +string |
- ApiDefinition: Information about the formal API definition for the app. +KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication. |
-apiManagementConfig+ limits- -ApiManagementConfig_STATUS + +SiteLimits |
- ApiManagementConfig: Azure API management settings linked to the app. +Limits: Site limits. |
-appCommandLine+ linuxFxVersionstring |
- AppCommandLine: App command line to launch. +LinuxFxVersion: Linux App Framework and version |
-appSettings+ loadBalancing- -[]NameValuePair_STATUS + +SiteConfig_LoadBalancing |
- AppSettings: Application settings. +LoadBalancing: Site load balancing. |
-autoHealEnabled+ localMySqlEnabledbool |
- AutoHealEnabled: LocalMySqlEnabled: |
-autoHealRules+ logsDirectorySizeLimit- -AutoHealRules_STATUS - +int |
- AutoHealRules: Auto Heal rules. +LogsDirectorySizeLimit: HTTP logs directory size limit. |
-autoSwapSlotName+ managedPipelineMode-string + +SiteConfig_ManagedPipelineMode + |
- AutoSwapSlotName: Auto-swap slot name. +ManagedPipelineMode: Managed pipeline mode. |
-azureStorageAccounts+ managedServiceIdentityId- -map[string]./api/web/v1api20220301.AzureStorageInfoValue_STATUS - +int |
- AzureStorageAccounts: List of Azure Storage Accounts. +ManagedServiceIdentityId: Managed Service Identity Id |
-connectionStrings+ minTlsVersion- -[]ConnStringInfo_STATUS + +SiteConfig_MinTlsVersion |
- ConnectionStrings: Connection strings. +MinTlsVersion: MinTlsVersion: configures the minimum version of TLS required for SSL requests |
-cors+ minimumElasticInstanceCount- -CorsSettings_STATUS - +int |
- Cors: Cross-Origin Resource Sharing (CORS) settings. +MinimumElasticInstanceCount: Number of minimum instance count for a site +This setting only applies to the Elastic Plans |
-defaultDocuments- -[]string - - |
-
- DefaultDocuments: Default documents. - |
-
-detailedErrorLoggingEnabled- -bool - - |
-
- DetailedErrorLoggingEnabled: |
-
-documentRoot+ netFrameworkVersionstring |
- DocumentRoot: Document root. - |
-
-experiments- - -Experiments_STATUS - - - |
-
- Experiments: This is work around for polymorphic types. +NetFrameworkVersion: .NET Framework version. |
-ftpsState+ nodeVersion- -SiteConfig_FtpsState_STATUS - +string |
- FtpsState: State of FTP / FTPS service +NodeVersion: Version of Node.js. |
-functionAppScaleLimit+ numberOfWorkersint |
- FunctionAppScaleLimit: Maximum number of workers that a site can scale out to. -This setting only applies to the Consumption and Elastic Premium Plans - |
-
-functionsRuntimeScaleMonitoringEnabled- -bool - - |
-
- FunctionsRuntimeScaleMonitoringEnabled: Gets or sets a value indicating whether functions runtime scale monitoring is -enabled. When enabled, -the ScaleController will not monitor event sources directly, but will instead call to the -runtime to get scale status. +NumberOfWorkers: Number of workers. |
-handlerMappings+ phpVersion- -[]HandlerMapping_STATUS - +string |
- HandlerMappings: Handler mappings. +PhpVersion: Version of PHP. |
-healthCheckPath+ powerShellVersionstring |
- HealthCheckPath: Health check path +PowerShellVersion: Version of PowerShell. |
-http20Enabled+ preWarmedInstanceCount-bool +int |
- Http20Enabled: Http20Enabled: configures a web site to allow clients to connect over http2.0 +PreWarmedInstanceCount: Number of preWarmed instances. +This setting only applies to the Consumption and Elastic Plans |
-httpLoggingEnabled+ publicNetworkAccess-bool +string |
- HttpLoggingEnabled: PublicNetworkAccess: Property to allow or block all public traffic. |
-ipSecurityRestrictions+ publishingUsername- -[]IpSecurityRestriction_STATUS - +string |
- IpSecurityRestrictions: IP security restrictions for main. +PublishingUsername: Publishing user name. |
-javaContainer+ push-string + +PushSettings + |
- JavaContainer: Java container. +Push: Push endpoint settings. |
-javaContainerVersion+ pythonVersionstring |
- JavaContainerVersion: Java container version. +PythonVersion: Version of Python. |
-javaVersion+ remoteDebuggingEnabled-string +bool |
- JavaVersion: Java version. +RemoteDebuggingEnabled: |
-keyVaultReferenceIdentity+ remoteDebuggingVersionstring |
- KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication. +RemoteDebuggingVersion: Remote debugging version. |
-limits+ requestTracingEnabled- -SiteLimits_STATUS - +bool |
- Limits: Site limits. +RequestTracingEnabled: |
-linuxFxVersion+ requestTracingExpirationTimestring |
- LinuxFxVersion: Linux App Framework and version +RequestTracingExpirationTime: Request tracing expiration time. |
-loadBalancing+ scmIpSecurityRestrictions- -SiteConfig_LoadBalancing_STATUS + +[]IpSecurityRestriction |
- LoadBalancing: Site load balancing. +ScmIpSecurityRestrictions: IP security restrictions for scm. |
-localMySqlEnabled+ scmIpSecurityRestrictionsUseMainbool |
- LocalMySqlEnabled: ScmIpSecurityRestrictionsUseMain: IP security restrictions for scm to use main. |
-logsDirectorySizeLimit+ scmMinTlsVersion-int + +SiteConfig_ScmMinTlsVersion + |
- LogsDirectorySizeLimit: HTTP logs directory size limit. +ScmMinTlsVersion: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site |
-machineKey+ scmType- -SiteMachineKey_STATUS + +SiteConfig_ScmType |
- MachineKey: Site MachineKey. +ScmType: SCM type. |
-managedPipelineMode+ tracingOptions- -SiteConfig_ManagedPipelineMode_STATUS - +string |
- ManagedPipelineMode: Managed pipeline mode. +TracingOptions: Tracing options. |
-managedServiceIdentityId+ use32BitWorkerProcess-int +bool |
- ManagedServiceIdentityId: Managed Service Identity Id +Use32BitWorkerProcess: |
-minTlsVersion+ virtualApplications- -SiteConfig_MinTlsVersion_STATUS + +[]VirtualApplication |
- MinTlsVersion: MinTlsVersion: configures the minimum version of TLS required for SSL requests +VirtualApplications: Virtual applications. |
-minimumElasticInstanceCount+ vnetName-int +string |
- MinimumElasticInstanceCount: Number of minimum instance count for a site -This setting only applies to the Elastic Plans +VnetName: Virtual Network name. |
-netFrameworkVersion+ vnetPrivatePortsCount-string +int |
- NetFrameworkVersion: .NET Framework version. +VnetPrivatePortsCount: The number of private ports assigned to this app. These will be assigned dynamically on runtime. |
-nodeVersion+ vnetRouteAllEnabled-string +bool |
- NodeVersion: Version of Node.js. +VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network +Security Groups and User Defined Routes applied. |
-numberOfWorkers+ webSocketsEnabled-int +bool |
- NumberOfWorkers: Number of workers. +WebSocketsEnabled: |
-phpVersion+ websiteTimeZonestring |
- PhpVersion: Version of PHP. +WebsiteTimeZone: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App +Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database +values https://www.iana.org/time-zones (for a quick reference see +https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under +HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones |
-powerShellVersion+ windowsFxVersionstring |
- PowerShellVersion: Version of PowerShell. +WindowsFxVersion: Xenon App Framework and version |
-preWarmedInstanceCount+ xManagedServiceIdentityIdint |
- PreWarmedInstanceCount: Number of preWarmed instances. -This setting only applies to the Consumption and Elastic Plans +XManagedServiceIdentityId: Explicit Managed Service Identity Id |
string alias)+(Appears on:SiteConfig) +
+
-publicNetworkAccess- -string - - |
-
- PublicNetworkAccess: Property to allow or block all public traffic. - |
+Value | +Description |
|---|---|---|---|
-publishingUsername- -string - - |
-
- PublishingUsername: Publishing user name. - |
+||
"AllAllowed" |
++ | ||
"Disabled" |
++ | ||
"FtpsOnly" |
++ |
string alias)+(Appears on:SiteConfig_STATUS) +
+| Value | +Description | +
|---|---|
"AllAllowed" |
++ |
"Disabled" |
++ |
"FtpsOnly" |
++ |
string alias)+(Appears on:SiteConfig) +
+| Value | +Description | +
|---|---|
"LeastRequests" |
++ |
"LeastResponseTime" |
++ |
"PerSiteRoundRobin" |
++ |
"RequestHash" |
++ |
"WeightedRoundRobin" |
++ |
"WeightedTotalTraffic" |
++ |
string alias)+(Appears on:SiteConfig_STATUS) +
+| Value | +Description | +
|---|---|
"LeastRequests" |
++ |
"LeastResponseTime" |
++ |
"PerSiteRoundRobin" |
++ |
"RequestHash" |
++ |
"WeightedRoundRobin" |
++ |
"WeightedTotalTraffic" |
++ |
string alias)+(Appears on:SiteConfig) +
+| Value | +Description | +
|---|---|
"Classic" |
++ |
"Integrated" |
++ |
string alias)+(Appears on:SiteConfig_STATUS) +
+| Value | +Description | +
|---|---|
"Classic" |
++ |
"Integrated" |
++ |
string alias)+(Appears on:SiteConfig) +
+| Value | +Description | +
|---|---|
"1.0" |
++ |
"1.1" |
++ |
"1.2" |
++ |
string alias)+(Appears on:SiteConfig_STATUS) +
+| Value | +Description | +
|---|---|
"1.0" |
++ |
"1.1" |
++ |
"1.2" |
++ |
+(Appears on:Site_STATUS) +
+Configuration of an App Service app.
+| Field | +Description |
|---|---|
-push+ acrUseManagedIdentityCreds- -PushSettings_STATUS - +bool |
- Push: Push endpoint settings. +AcrUseManagedIdentityCreds: Flag to use Managed Identity Creds for ACR pull |
-pythonVersion+ acrUserManagedIdentityIDstring |
- PythonVersion: Version of Python. +AcrUserManagedIdentityID: If using user managed identity, the user managed identity ClientId |
-remoteDebuggingEnabled+ alwaysOnbool |
- RemoteDebuggingEnabled: AlwaysOn: |
-remoteDebuggingVersion+ apiDefinition+ + +ApiDefinitionInfo_STATUS + + + |
+
+ ApiDefinition: Information about the formal API definition for the app. + |
+
+apiManagementConfig+ + +ApiManagementConfig_STATUS + + + |
+
+ ApiManagementConfig: Azure API management settings linked to the app. + |
+
+appCommandLinestring |
- RemoteDebuggingVersion: Remote debugging version. +AppCommandLine: App command line to launch. |
-requestTracingEnabled+ appSettings+ + +[]NameValuePair_STATUS + + + |
+
+ AppSettings: Application settings. + |
+
+autoHealEnabledbool |
- RequestTracingEnabled: AutoHealEnabled: |
-requestTracingExpirationTime+ autoHealRules-string + +AutoHealRules_STATUS + |
- RequestTracingExpirationTime: Request tracing expiration time. +AutoHealRules: Auto Heal rules. + |
+
+autoSwapSlotName+ +string + + |
+
+ AutoSwapSlotName: Auto-swap slot name. + |
+
+azureStorageAccounts+ + +map[string]./api/web/v1api20220301.AzureStorageInfoValue_STATUS + + + |
+
+ AzureStorageAccounts: List of Azure Storage Accounts. + |
+
+connectionStrings+ + +[]ConnStringInfo_STATUS + + + |
+
+ ConnectionStrings: Connection strings. + |
+
+cors+ + +CorsSettings_STATUS + + + |
+
+ Cors: Cross-Origin Resource Sharing (CORS) settings. + |
+
+defaultDocuments+ +[]string + + |
+
+ DefaultDocuments: Default documents. + |
+
+detailedErrorLoggingEnabled+ +bool + + |
+
+ DetailedErrorLoggingEnabled: |
+
+documentRoot+ +string + + |
+
+ DocumentRoot: Document root. + |
+
+experiments+ + +Experiments_STATUS + + + |
+
+ Experiments: This is work around for polymorphic types. + |
+
+ftpsState+ + +SiteConfig_FtpsState_STATUS + + + |
+
+ FtpsState: State of FTP / FTPS service + |
+
+functionAppScaleLimit+ +int + + |
+
+ FunctionAppScaleLimit: Maximum number of workers that a site can scale out to. +This setting only applies to the Consumption and Elastic Premium Plans + |
+
+functionsRuntimeScaleMonitoringEnabled+ +bool + + |
+
+ FunctionsRuntimeScaleMonitoringEnabled: Gets or sets a value indicating whether functions runtime scale monitoring is +enabled. When enabled, +the ScaleController will not monitor event sources directly, but will instead call to the +runtime to get scale status. + |
+
+handlerMappings+ + +[]HandlerMapping_STATUS + + + |
+
+ HandlerMappings: Handler mappings. + |
+
+healthCheckPath+ +string + + |
+
+ HealthCheckPath: Health check path + |
+
+http20Enabled+ +bool + + |
+
+ Http20Enabled: Http20Enabled: configures a web site to allow clients to connect over http2.0 + |
+
+httpLoggingEnabled+ +bool + + |
+
+ HttpLoggingEnabled: |
+
+ipSecurityRestrictions+ + +[]IpSecurityRestriction_STATUS + + + |
+
+ IpSecurityRestrictions: IP security restrictions for main. + |
+
+javaContainer+ +string + + |
+
+ JavaContainer: Java container. + |
+
+javaContainerVersion+ +string + + |
+
+ JavaContainerVersion: Java container version. + |
+
+javaVersion+ +string + + |
+
+ JavaVersion: Java version. + |
+
+keyVaultReferenceIdentity+ +string + + |
+
+ KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication. + |
+
+limits+ + +SiteLimits_STATUS + + + |
+
+ Limits: Site limits. + |
+
+linuxFxVersion+ +string + + |
+
+ LinuxFxVersion: Linux App Framework and version + |
+
+loadBalancing+ + +SiteConfig_LoadBalancing_STATUS + + + |
+
+ LoadBalancing: Site load balancing. + |
+
+localMySqlEnabled+ +bool + + |
+
+ LocalMySqlEnabled: |
+
+logsDirectorySizeLimit+ +int + + |
+
+ LogsDirectorySizeLimit: HTTP logs directory size limit. + |
+
+machineKey+ + +SiteMachineKey_STATUS + + + |
+
+ MachineKey: Site MachineKey. + |
+
+managedPipelineMode+ + +SiteConfig_ManagedPipelineMode_STATUS + + + |
+
+ ManagedPipelineMode: Managed pipeline mode. + |
+
+managedServiceIdentityId+ +int + + |
+
+ ManagedServiceIdentityId: Managed Service Identity Id + |
+
+minTlsVersion+ + +SiteConfig_MinTlsVersion_STATUS + + + |
+
+ MinTlsVersion: MinTlsVersion: configures the minimum version of TLS required for SSL requests + |
+
+minimumElasticInstanceCount+ +int + + |
+
+ MinimumElasticInstanceCount: Number of minimum instance count for a site +This setting only applies to the Elastic Plans + |
+
+netFrameworkVersion+ +string + + |
+
+ NetFrameworkVersion: .NET Framework version. + |
+
+nodeVersion+ +string + + |
+
+ NodeVersion: Version of Node.js. + |
+
+numberOfWorkers+ +int + + |
+
+ NumberOfWorkers: Number of workers. + |
+
+phpVersion+ +string + + |
+
+ PhpVersion: Version of PHP. + |
+
+powerShellVersion+ +string + + |
+
+ PowerShellVersion: Version of PowerShell. + |
+
+preWarmedInstanceCount+ +int + + |
+
+ PreWarmedInstanceCount: Number of preWarmed instances. +This setting only applies to the Consumption and Elastic Plans + |
+
+publicNetworkAccess+ +string + + |
+
+ PublicNetworkAccess: Property to allow or block all public traffic. + |
+
+publishingUsername+ +string + + |
+
+ PublishingUsername: Publishing user name. + |
+
+push+ + +PushSettings_STATUS + + + |
+
+ Push: Push endpoint settings. + |
+
+pythonVersion+ +string + + |
+
+ PythonVersion: Version of Python. + |
+
+remoteDebuggingEnabled+ +bool + + |
+
+ RemoteDebuggingEnabled: |
+
+remoteDebuggingVersion+ +string + + |
+
+ RemoteDebuggingVersion: Remote debugging version. + |
+
+requestTracingEnabled+ +bool + + |
+
+ RequestTracingEnabled: |
+
+requestTracingExpirationTime+ +string + + |
+
+ RequestTracingExpirationTime: Request tracing expiration time. + |
+
+scmIpSecurityRestrictions+ + +[]IpSecurityRestriction_STATUS + + + |
+
+ ScmIpSecurityRestrictions: IP security restrictions for scm. + |
+
+scmIpSecurityRestrictionsUseMain+ +bool + + |
+
+ ScmIpSecurityRestrictionsUseMain: IP security restrictions for scm to use main. + |
+
+scmMinTlsVersion+ + +SiteConfig_ScmMinTlsVersion_STATUS + + + |
+
+ ScmMinTlsVersion: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site + |
+
+scmType+ + +SiteConfig_ScmType_STATUS + + + |
+
+ ScmType: SCM type. + |
+
+tracingOptions+ +string + + |
+
+ TracingOptions: Tracing options. + |
+
+use32BitWorkerProcess+ +bool + + |
+
+ Use32BitWorkerProcess: |
+
+virtualApplications+ + +[]VirtualApplication_STATUS + + + |
+
+ VirtualApplications: Virtual applications. + |
+
+vnetName+ +string + + |
+
+ VnetName: Virtual Network name. + |
+
+vnetPrivatePortsCount+ +int + + |
+
+ VnetPrivatePortsCount: The number of private ports assigned to this app. These will be assigned dynamically on runtime. + |
+
+vnetRouteAllEnabled+ +bool + + |
+
+ VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network +Security Groups and User Defined Routes applied. + |
+
+webSocketsEnabled+ +bool + + |
+
+ WebSocketsEnabled: |
+
+websiteTimeZone+ +string + + |
+
+ WebsiteTimeZone: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App +Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database +values https://www.iana.org/time-zones (for a quick reference see +https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under +HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones + |
+
+windowsFxVersion+ +string + + |
+
+ WindowsFxVersion: Xenon App Framework and version + |
+
+xManagedServiceIdentityId+ +int + + |
+
+ XManagedServiceIdentityId: Explicit Managed Service Identity Id + |
+
string alias)+(Appears on:SiteConfig) +
+| Value | +Description | +
|---|---|
"1.0" |
++ |
"1.1" |
++ |
"1.2" |
++ |
string alias)+(Appears on:SiteConfig_STATUS) +
+| Value | +Description | +
|---|---|
"1.0" |
++ |
"1.1" |
++ |
"1.2" |
++ |
string alias)+(Appears on:SiteConfig) +
+| Value | +Description | +
|---|---|
"BitbucketGit" |
++ |
"BitbucketHg" |
++ |
"CodePlexGit" |
++ |
"CodePlexHg" |
++ |
"Dropbox" |
++ |
"ExternalGit" |
++ |
"ExternalHg" |
++ |
"GitHub" |
++ |
"LocalGit" |
++ |
"None" |
++ |
"OneDrive" |
++ |
"Tfs" |
++ |
"VSO" |
++ |
"VSTSRM" |
++ |
string alias)+(Appears on:SiteConfig_STATUS) +
+| Value | +Description | +
|---|---|
"BitbucketGit" |
++ |
"BitbucketHg" |
++ |
"CodePlexGit" |
++ |
"CodePlexHg" |
++ |
"Dropbox" |
++ |
"ExternalGit" |
++ |
"ExternalHg" |
++ |
"GitHub" |
++ |
"LocalGit" |
++ |
"None" |
++ |
"OneDrive" |
++ |
"Tfs" |
++ |
"VSO" |
++ |
"VSTSRM" |
++ |
+(Appears on:SiteConfig) +
+Metric limits set on an app.
+| Field | +Description | +
|---|---|
+maxDiskSizeInMb+ +int + + |
+
+ MaxDiskSizeInMb: Maximum allowed disk size usage in MB. + |
+
+maxMemoryInMb+ +int + + |
+
+ MaxMemoryInMb: Maximum allowed memory usage in MB. + |
+
+maxPercentageCpu+ +float64 + + |
+
+ MaxPercentageCpu: Maximum allowed CPU usage percentage. + |
+
+(Appears on:SiteConfig_STATUS) +
+Metric limits set on an app.
+| Field | +Description | +
|---|---|
+maxDiskSizeInMb+ +int + + |
+
+ MaxDiskSizeInMb: Maximum allowed disk size usage in MB. + |
+
+maxMemoryInMb+ +int + + |
+
+ MaxMemoryInMb: Maximum allowed memory usage in MB. + |
+
+maxPercentageCpu+ +float64 + + |
+
+ MaxPercentageCpu: Maximum allowed CPU usage percentage. + |
+
+(Appears on:SiteConfig_STATUS) +
+MachineKey of an app.
+| Field | +Description | +
|---|---|
+decryption+ +string + + |
+
+ Decryption: Algorithm used for decryption. + |
+
+decryptionKey+ +string + + |
+
+ DecryptionKey: Decryption key. + |
+
+validation+ +string + + |
+
+ Validation: MachineKey validation. + |
+
+validationKey+ +string + + |
+
+ ValidationKey: Validation key. + |
+
+(Appears on:Site_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). + |
+
string alias)+(Appears on:Site_STATUS) +
+| Value | +Description | +
|---|---|
"DisasterRecoveryMode" |
++ |
"Limited" |
++ |
"Normal" |
++ |
string alias)+(Appears on:Site_STATUS) +
+| Value | +Description | +
|---|---|
"Optional" |
++ |
"OptionalInteractiveUser" |
++ |
"Required" |
++ |
string alias)+(Appears on:Site_Spec) +
+| Value | +Description | +
|---|---|
"Optional" |
++ |
"OptionalInteractiveUser" |
++ |
"Required" |
++ |
string alias)+(Appears on:Site_STATUS) +
+| Value | +Description | +
|---|---|
"ActiveActive" |
++ |
"Failover" |
++ |
"GeoRedundant" |
++ |
"Manual" |
++ |
"None" |
++ |
string alias)+(Appears on:Site_Spec) +
+| Value | +Description | +
|---|---|
"ActiveActive" |
++ |
"Failover" |
++ |
"GeoRedundant" |
++ |
"Manual" |
++ |
"None" |
++ |
string alias)+(Appears on:Site_STATUS) +
+| Value | +Description | +
|---|---|
"Exceeded" |
++ |
"Normal" |
++ |
+(Appears on:Site) +
+A web app, a mobile app backend, or an API app.
+| Field | +Description | +
|---|---|
+availabilityState+ + +Site_Properties_AvailabilityState_STATUS + + + |
+
+ AvailabilityState: Management information availability state for the app. |
-scmIpSecurityRestrictions+ clientAffinityEnabled- -[]IpSecurityRestriction_STATUS - +bool |
- ScmIpSecurityRestrictions: IP security restrictions for scm. +ClientAffinityEnabled: |
-scmIpSecurityRestrictionsUseMain+ clientCertEnabledbool |
- ScmIpSecurityRestrictionsUseMain: IP security restrictions for scm to use main. +ClientCertEnabled: |
-scmMinTlsVersion+ clientCertExclusionPaths- -SiteConfig_ScmMinTlsVersion_STATUS - +string |
- ScmMinTlsVersion: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site +ClientCertExclusionPaths: client certificate authentication comma-separated exclusion paths |
-scmType+ clientCertMode- -SiteConfig_ScmType_STATUS + +Site_Properties_ClientCertMode_STATUS |
- ScmType: SCM type. +ClientCertMode: This composes with ClientCertEnabled setting. +- ClientCertEnabled: false means ClientCert is ignored. +- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. +- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. |
-tracingOptions+ cloningInfo-string + +CloningInfo_STATUS + |
- TracingOptions: Tracing options. +CloningInfo: If specified during app creation, the app is cloned from a source app. |
-use32BitWorkerProcess+ conditions-bool + +[]genruntime/conditions.Condition + |
- Use32BitWorkerProcess: Conditions: The observed state of the resource |
-virtualApplications+ containerSize- -[]VirtualApplication_STATUS - +int |
- VirtualApplications: Virtual applications. +ContainerSize: Size of the function container. |
-vnetName+ customDomainVerificationIdstring |
- VnetName: Virtual Network name. +CustomDomainVerificationId: Unique identifier that verifies the custom domains assigned to the app. Customer will add +this id to a txt record for verification. |
-vnetPrivatePortsCount+ dailyMemoryTimeQuotaint |
- VnetPrivatePortsCount: The number of private ports assigned to this app. These will be assigned dynamically on runtime. +DailyMemoryTimeQuota: Maximum allowed daily memory-time quota (applicable on dynamic apps only). |
-vnetRouteAllEnabled+ defaultHostName-bool +string |
- VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network -Security Groups and User Defined Routes applied. +DefaultHostName: Default hostname of the app. Read-only. |
-webSocketsEnabled+ enabledbool |
- WebSocketsEnabled: Enabled: |
-websiteTimeZone+ enabledHostNames-string +[]string |
- WebsiteTimeZone: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App -Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database -values https://www.iana.org/time-zones (for a quick reference see -https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under -HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones +EnabledHostNames: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, +the app is not served on those hostnames. |
-windowsFxVersion+ extendedLocation-string + +ExtendedLocation_STATUS + |
- WindowsFxVersion: Xenon App Framework and version +ExtendedLocation: Extended Location. |
-xManagedServiceIdentityId+ hostNameSslStates-int + +[]HostNameSslState_STATUS + |
- XManagedServiceIdentityId: Explicit Managed Service Identity Id +HostNameSslStates: Hostname SSL states are used to manage the SSL bindings for app’s hostnames. |
string alias)-(Appears on:SiteConfig) -
-| Value | -Description | -
|---|---|
"1.0" |
-- |
"1.1" |
-- |
"1.2" |
-- |
string alias)-(Appears on:SiteConfig_STATUS) -
-| Value | -Description | -
|---|---|
"1.0" |
-- |
"1.1" |
-- |
"1.2" |
-- |
string alias)-(Appears on:SiteConfig) -
-| Value | -Description | -
|---|---|
"BitbucketGit" |
-- |
"BitbucketHg" |
-- |
"CodePlexGit" |
-- |
"CodePlexHg" |
-- |
"Dropbox" |
-- |
"ExternalGit" |
-- |
"ExternalHg" |
-- |
"GitHub" |
-- |
"LocalGit" |
-- |
"None" |
-- |
"OneDrive" |
-- |
"Tfs" |
-- |
"VSO" |
-- |
"VSTSRM" |
-- |
string alias)-(Appears on:SiteConfig_STATUS) -
-| Value | -Description | -
|---|---|
"BitbucketGit" |
-- |
"BitbucketHg" |
-- |
"CodePlexGit" |
-- |
"CodePlexHg" |
-- |
"Dropbox" |
-- |
"ExternalGit" |
-- |
"ExternalHg" |
-- |
"GitHub" |
-- |
"LocalGit" |
-- |
"None" |
-- |
"OneDrive" |
-- |
"Tfs" |
-- |
"VSO" |
-- |
"VSTSRM" |
-- |
-(Appears on:SiteConfig) -
-Metric limits set on an app.
-| Field | -Description | -
|---|---|
-maxDiskSizeInMb+ hostNames-int +[]string |
- MaxDiskSizeInMb: Maximum allowed disk size usage in MB. +HostNames: Hostnames associated with the app. |
-maxMemoryInMb+ hostNamesDisabled-int +bool |
- MaxMemoryInMb: Maximum allowed memory usage in MB. +HostNamesDisabled: |
-maxPercentageCpu+ hostingEnvironmentProfile-float64 + +HostingEnvironmentProfile_STATUS + |
- MaxPercentageCpu: Maximum allowed CPU usage percentage. +HostingEnvironmentProfile: App Service Environment to use for the app. |
-(Appears on:SiteConfig_STATUS) -
-Metric limits set on an app.
-| Field | -Description | -
|---|---|
-maxDiskSizeInMb+ httpsOnly-int +bool |
- MaxDiskSizeInMb: Maximum allowed disk size usage in MB. +HttpsOnly: HttpsOnly: configures a web site to accept only https requests. Issues redirect for +http requests |
-maxMemoryInMb+ hyperV-int +bool |
- MaxMemoryInMb: Maximum allowed memory usage in MB. +HyperV: Hyper-V sandbox. |
-maxPercentageCpu+ id-float64 +string |
- MaxPercentageCpu: Maximum allowed CPU usage percentage. +Id: Resource Id. |
-(Appears on:SiteConfig_STATUS) -
-MachineKey of an app.
-| Field | -Description | +
+identity+ + +ManagedServiceIdentity_STATUS + + + |
+
+ Identity: Managed service identity. + |
|---|---|---|---|
-decryption+ inProgressOperationIdstring |
- Decryption: Algorithm used for decryption. +InProgressOperationId: Specifies an operation id if this site has a pending operation. |
||
-decryptionKey+ isDefaultContainer-string +bool |
- DecryptionKey: Decryption key. +IsDefaultContainer: |
||
-validation+ isXenon-string +bool |
- Validation: MachineKey validation. +IsXenon: Obsolete: Hyper-V sandbox. |
||
-validationKey+ keyVaultReferenceIdentitystring |
- ValidationKey: Validation key. +KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication. |
-(Appears on:Site_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+ kind- -[]genruntime/core.DestinationExpression - +string |
- ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). +Kind: Kind of resource. |
-secretExpressions+ lastModifiedTimeUtc- -[]genruntime/core.DestinationExpression - +string |
- SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). +LastModifiedTimeUtc: Last time the app was modified, in UTC. Read-only. |
string alias)-(Appears on:Site_STATUS) -
-| Value | -Description | -
|---|---|
"DisasterRecoveryMode" |
-- |
"Limited" |
-- |
"Normal" |
-- |
string alias)-(Appears on:Site_STATUS) -
-| Value | -Description | -
|---|---|
"Optional" |
-- |
"OptionalInteractiveUser" |
-- |
"Required" |
-- |
string alias)-(Appears on:Site_Spec) -
-| Value | -Description | +
+location+ +string + + |
+
+ Location: Resource Location. + |
|---|---|---|---|
"Optional" |
-- | ||
"OptionalInteractiveUser" |
-- | ||
"Required" |
-- |
string alias)-(Appears on:Site_STATUS) -
-| Value | -Description | -
|---|---|
"ActiveActive" |
-- |
"Failover" |
-- |
"GeoRedundant" |
-- |
"Manual" |
-- |
"None" |
-- |
string alias)-(Appears on:Site_Spec) -
-
+maxNumberOfWorkers+ +int + + |
+
+ MaxNumberOfWorkers: Maximum number of workers. +This only applies to Functions container. + |
+
||
| Value | -Description | +
+name+ +string + + |
+
+ Name: Resource Name. + |
|---|---|---|---|
"ActiveActive" |
-- | ||
"Failover" |
-- | ||
"GeoRedundant" |
-- | ||
"Manual" |
-- | ||
"None" |
-- |
string alias)-(Appears on:Site_STATUS) -
-| Value | -Description | +
+outboundIpAddresses+ +string + + |
+
+ OutboundIpAddresses: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes +VIPs from tenants that site can be hosted with current settings. Read-only. + |
|---|---|---|---|
"Exceeded" |
-- | ||
"Normal" |
-- |
-(Appears on:Site) -
-A web app, a mobile app backend, or an API app.
-| Field | -Description | +
+possibleOutboundIpAddresses+ +string + + |
+
+ PossibleOutboundIpAddresses: List of IP addresses that the app uses for outbound connections (e.g. database access). +Includes VIPs from all tenants except dataComponent. Read-only. + |
|---|---|---|---|
-availabilityState+ publicNetworkAccess- -Site_Properties_AvailabilityState_STATUS +string + + |
+
+ PublicNetworkAccess: Property to allow or block all public traffic. Allowed Values: ‘Enabled’, ‘Disabled’ or an empty +string. + |
+||
+redundancyMode+ + +Site_Properties_RedundancyMode_STATUS |
- AvailabilityState: Management information availability state for the app. +RedundancyMode: Site redundancy mode |
||
-clientAffinityEnabled+ repositorySiteName-bool +string |
- ClientAffinityEnabled: RepositorySiteName: Name of the repository site. |
||
-clientCertEnabled+ reservedbool |
- ClientCertEnabled: Reserved: |
||
-clientCertExclusionPaths+ resourceGroupstring |
- ClientCertExclusionPaths: client certificate authentication comma-separated exclusion paths +ResourceGroup: Name of the resource group the app belongs to. Read-only. |
||
-clientCertMode+ scmSiteAlsoStopped- -Site_Properties_ClientCertMode_STATUS - +bool |
- ClientCertMode: This composes with ClientCertEnabled setting. -- ClientCertEnabled: false means ClientCert is ignored. -- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. -- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. +ScmSiteAlsoStopped: |
||
-cloningInfo+ serverFarmId- -CloningInfo_STATUS - +string |
- CloningInfo: If specified during app creation, the app is cloned from a source app. +ServerFarmId: Resource ID of the associated App Service plan, formatted as: +“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”. |
||
-conditions+ siteConfig- -[]genruntime/conditions.Condition + +SiteConfig_STATUS |
- Conditions: The observed state of the resource +SiteConfig: Configuration of the app. |
||
-containerSize+ slotSwapStatus-int + +SlotSwapStatus_STATUS + |
- ContainerSize: Size of the function container. +SlotSwapStatus: Status of the last deployment slot swap operation. |
||
-customDomainVerificationId+ statestring |
- CustomDomainVerificationId: Unique identifier that verifies the custom domains assigned to the app. Customer will add -this id to a txt record for verification. +State: Current state of the app. |
||
-dailyMemoryTimeQuota+ storageAccountRequired-int +bool |
- DailyMemoryTimeQuota: Maximum allowed daily memory-time quota (applicable on dynamic apps only). +StorageAccountRequired: Checks if Customer provided storage account is required |
||
-defaultHostName+ suspendedTillstring |
- DefaultHostName: Default hostname of the app. Read-only. +SuspendedTill: App suspended till in case memory-time quota is exceeded. |
||
-enabled+ tags-bool +map[string]string |
- Enabled: Tags: Resource tags. |
||
-enabledHostNames+ targetSwapSlot+ +string + + |
+
+ TargetSwapSlot: Specifies which deployment slot this app will swap into. Read-only. + |
+||
+trafficManagerHostNames[]string |
- EnabledHostNames: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, -the app is not served on those hostnames. +TrafficManagerHostNames: Azure Traffic Manager hostnames associated with the app. Read-only. |
||
-extendedLocation+ type- -ExtendedLocation_STATUS - +string |
- ExtendedLocation: Extended Location. +Type: Resource type. |
||
-hostNameSslStates+ usageState- -[]HostNameSslState_STATUS + +Site_Properties_UsageState_STATUS |
- HostNameSslStates: Hostname SSL states are used to manage the SSL bindings for app’s hostnames. +UsageState: State indicating whether the app has exceeded its quota usage. Read-only. |
||
-hostNames+ virtualNetworkSubnetId-[]string +string |
- HostNames: Hostnames associated with the app. +VirtualNetworkSubnetId: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET +Integration. +This must be of the form +/subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} |
||
-hostNamesDisabled+ vnetContentShareEnabledbool |
- HostNamesDisabled: VnetContentShareEnabled: To enable accessing content over virtual network |
||
-hostingEnvironmentProfile+ vnetImagePullEnabled- -HostingEnvironmentProfile_STATUS - +bool |
- HostingEnvironmentProfile: App Service Environment to use for the app. +VnetImagePullEnabled: To enable pulling image over Virtual Network |
||
-httpsOnly+ vnetRouteAllEnabledbool |
- HttpsOnly: HttpsOnly: configures a web site to accept only https requests. Issues redirect for -http requests +VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network +Security Groups and User Defined Routes applied. |
+(Appears on:Site) +
+| Field | +Description | +
|---|---|
-hyperV+ azureName-bool +string |
- HyperV: Hyper-V sandbox. +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. |
-id+ clientAffinityEnabled-string +bool |
- Id: Resource Id. +ClientAffinityEnabled: |
-identity+ clientCertEnabled- -ManagedServiceIdentity_STATUS - +bool |
- Identity: Managed service identity. +ClientCertEnabled: |
-inProgressOperationId+ clientCertExclusionPathsstring |
- InProgressOperationId: Specifies an operation id if this site has a pending operation. +ClientCertExclusionPaths: client certificate authentication comma-separated exclusion paths |
-isDefaultContainer+ clientCertMode-bool + +Site_Properties_ClientCertMode_Spec + |
- IsDefaultContainer: ClientCertMode: This composes with ClientCertEnabled setting. +- ClientCertEnabled: false means ClientCert is ignored. +- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. +- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted. |
-isXenon+ cloningInfo-bool + +CloningInfo + |
- IsXenon: Obsolete: Hyper-V sandbox. +CloningInfo: If specified during app creation, the app is cloned from a source app. |
-keyVaultReferenceIdentity+ containerSize-string +int |
- KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication. +ContainerSize: Size of the function container. |
-kind+ customDomainVerificationIdstring |
- Kind: Kind of resource. +CustomDomainVerificationId: Unique identifier that verifies the custom domains assigned to the app. Customer will add +this id to a txt record for verification. |
-lastModifiedTimeUtc+ dailyMemoryTimeQuota-string +int |
- LastModifiedTimeUtc: Last time the app was modified, in UTC. Read-only. +DailyMemoryTimeQuota: Maximum allowed daily memory-time quota (applicable on dynamic apps only). |
-location+ enabled-string +bool |
- Location: Resource Location. +Enabled: |
-maxNumberOfWorkers+ extendedLocation-int + +ExtendedLocation + |
- MaxNumberOfWorkers: Maximum number of workers. -This only applies to Functions container. +ExtendedLocation: Extended Location. |
-name+ hostNameSslStates-string + +[]HostNameSslState + |
- Name: Resource Name. +HostNameSslStates: Hostname SSL states are used to manage the SSL bindings for app’s hostnames. |
-outboundIpAddresses+ hostNamesDisabled-string +bool |
- OutboundIpAddresses: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes -VIPs from tenants that site can be hosted with current settings. Read-only. +HostNamesDisabled: |
-possibleOutboundIpAddresses+ hostingEnvironmentProfile-string + +HostingEnvironmentProfile + |
- PossibleOutboundIpAddresses: List of IP addresses that the app uses for outbound connections (e.g. database access). -Includes VIPs from all tenants except dataComponent. Read-only. +HostingEnvironmentProfile: App Service Environment to use for the app. |
-publicNetworkAccess+ httpsOnly-string +bool |
- PublicNetworkAccess: Property to allow or block all public traffic. Allowed Values: ‘Enabled’, ‘Disabled’ or an empty -string. +HttpsOnly: HttpsOnly: configures a web site to accept only https requests. Issues redirect for +http requests |
-redundancyMode+ hyperV- -Site_Properties_RedundancyMode_STATUS - +bool |
- RedundancyMode: Site redundancy mode +HyperV: Hyper-V sandbox. |
-repositorySiteName+ identity-string + +ManagedServiceIdentity + |
- RepositorySiteName: Name of the repository site. +Identity: Managed service identity. |
-reserved+ isXenonbool |
- Reserved: IsXenon: Obsolete: Hyper-V sandbox. |
-resourceGroup+ keyVaultReferenceIdentitystring |
- ResourceGroup: Name of the resource group the app belongs to. Read-only. +KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication. |
-scmSiteAlsoStopped+ kind-bool +string |
- ScmSiteAlsoStopped: Kind: Kind of resource. |
-serverFarmId+ locationstring |
- ServerFarmId: Resource ID of the associated App Service plan, formatted as: -“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”. + Location: Resource Location. |
-siteConfig+ operatorSpec- -SiteConfig_STATUS + +SiteOperatorSpec |
- SiteConfig: Configuration of the app. +OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure |
-slotSwapStatus+ owner- -SlotSwapStatus_STATUS + +genruntime.KnownResourceReference |
- SlotSwapStatus: Status of the last deployment slot swap operation. +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 |
-state+ publicNetworkAccessstring |
- State: Current state of the app. +PublicNetworkAccess: Property to allow or block all public traffic. Allowed Values: ‘Enabled’, ‘Disabled’ or an empty +string. |
-storageAccountRequired+ redundancyMode-bool + +Site_Properties_RedundancyMode_Spec + |
- StorageAccountRequired: Checks if Customer provided storage account is required +RedundancyMode: Site redundancy mode |
-suspendedTill+ reserved-string +bool |
- SuspendedTill: App suspended till in case memory-time quota is exceeded. +Reserved: |
-tags+ scmSiteAlsoStopped-map[string]string +bool |
- Tags: Resource tags. +ScmSiteAlsoStopped: |
-targetSwapSlot+ serverFarmReference-string + +genruntime.ResourceReference + |
- TargetSwapSlot: Specifies which deployment slot this app will swap into. Read-only. +ServerFarmReference: Resource ID of the associated App Service plan, formatted as: +“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”. |
-trafficManagerHostNames+ siteConfig-[]string + +SiteConfig + |
- TrafficManagerHostNames: Azure Traffic Manager hostnames associated with the app. Read-only. +SiteConfig: Configuration of the app. |
-type+ storageAccountRequired-string +bool |
- Type: Resource type. +StorageAccountRequired: Checks if Customer provided storage account is required |
-usageState+ tags- -Site_Properties_UsageState_STATUS - +map[string]string |
- UsageState: State indicating whether the app has exceeded its quota usage. Read-only. +Tags: Resource tags. |
-virtualNetworkSubnetId+ virtualNetworkSubnetReference-string + +genruntime.ResourceReference + |
- VirtualNetworkSubnetId: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET + VirtualNetworkSubnetReference: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} @@ -7817,12 +8592,12 @@ Security Groups and User Defined Routes applied. |
-(Appears on:Site) -
Generator information: +- Generated from: /web/resource-manager/Microsoft.Web/stable/2022-03-01/WebApps.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web
-azureName+ metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||
+spec+ + +SitesSourcecontrol_Spec + + + |
+
+ + +
|
||||||||||||||||||||
-extendedLocation+ status- -ExtendedLocation + +SitesSourcecontrol_STATUS |
- ExtendedLocation: Extended Location. |
+(Appears on:SitesSourcecontrol_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
-hostNameSslStates+ configMapExpressions- -[]HostNameSslState + +[]genruntime/core.DestinationExpression |
- HostNameSslStates: Hostname SSL states are used to manage the SSL bindings for app’s hostnames. +ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions). |
-hostNamesDisabled+ secretExpressions-bool + +[]genruntime/core.DestinationExpression + |
- HostNamesDisabled: SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions). |
+(Appears on:SitesSourcecontrol) +
+| Field | +Description | +
|---|---|
-hostingEnvironmentProfile+ branch- -HostingEnvironmentProfile - +string |
- HostingEnvironmentProfile: App Service Environment to use for the app. +Branch: Name of branch to use for deployment. |
-httpsOnly+ conditions-bool + +[]genruntime/conditions.Condition + |
- HttpsOnly: HttpsOnly: configures a web site to accept only https requests. Issues redirect for -http requests +Conditions: The observed state of the resource |
-hyperV+ deploymentRollbackEnabledbool |
- HyperV: Hyper-V sandbox. +DeploymentRollbackEnabled: |
-identity+ gitHubActionConfiguration- -ManagedServiceIdentity + +GitHubActionConfiguration_STATUS |
- Identity: Managed service identity. +GitHubActionConfiguration: If GitHub Action is selected, than the associated configuration. |
-isXenon+ id-bool +string |
- IsXenon: Obsolete: Hyper-V sandbox. +Id: Resource Id. |
-keyVaultReferenceIdentity+ isGitHubAction-string +bool |
- KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication. +IsGitHubAction: |
-kind+ isManualIntegration-string +bool |
- Kind: Kind of resource. +IsManualIntegration: |
-location+ isMercurial-string +bool |
- Location: Resource Location. +IsMercurial: |
-operatorSpec+ kind- -SiteOperatorSpec - +string |
- OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not -passed directly to Azure +Kind: Kind of resource. |
-owner+ name- -genruntime.KnownResourceReference - +string |
- 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 +Name: Resource Name. |
-publicNetworkAccess+ repoUrlstring |
- PublicNetworkAccess: Property to allow or block all public traffic. Allowed Values: ‘Enabled’, ‘Disabled’ or an empty -string. +RepoUrl: Repository or source control URL. |
-redundancyMode+ type- -Site_Properties_RedundancyMode_Spec - +string |
- RedundancyMode: Site redundancy mode +Type: Resource type. |
+(Appears on:SitesSourcecontrol) +
+| Field | +Description | +
|---|---|
-reserved+ branch-bool +string |
- Reserved: Branch: Name of branch to use for deployment. |
-scmSiteAlsoStopped+ deploymentRollbackEnabledbool |
- ScmSiteAlsoStopped: DeploymentRollbackEnabled: |
-serverFarmReference+ gitHubActionConfiguration- -genruntime.ResourceReference + +GitHubActionConfiguration |
- ServerFarmReference: Resource ID of the associated App Service plan, formatted as: -“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”. + GitHubActionConfiguration: If GitHub Action is selected, than the associated configuration. |
-siteConfig+ isGitHubAction- -SiteConfig - +bool |
- SiteConfig: Configuration of the app. +IsGitHubAction: |
-storageAccountRequired+ isManualIntegrationbool |
- StorageAccountRequired: Checks if Customer provided storage account is required +IsManualIntegration: |
-tags+ isMercurial-map[string]string +bool |
- Tags: Resource tags. +IsMercurial: |
-virtualNetworkSubnetReference+ kind- -genruntime.ResourceReference - +string |
- VirtualNetworkSubnetReference: Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET -Integration. -This must be of the form -/subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} + Kind: Kind of resource. |
-vnetContentShareEnabled+ operatorSpec-bool + +SitesSourcecontrolOperatorSpec + |
- VnetContentShareEnabled: To enable accessing content over virtual network +OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not +passed directly to Azure |
-vnetImagePullEnabled+ owner-bool + +genruntime.KnownResourceReference + |
- VnetImagePullEnabled: To enable pulling image over Virtual Network +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 web.azure.com/Site resource |
-vnetRouteAllEnabled+ repoUrl-bool +string |
- VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network -Security Groups and User Defined Routes applied. +RepoUrl: Repository or source control URL. |