Package v1api20220801 contains API Schema definitions for the apimanagement v1api20220801 API group
+string alias)| Value | +Description | +
|---|---|
"2022-08-01" |
++ |
+(Appears on:Service_Spec) +
+Description of an additional API Management resource location.
+| Field | +Description | +
|---|---|
+disableGateway+ +bool + + |
+
+ DisableGateway: Property only valid for an Api Management service deployed in multiple locations. This can be used to +disable the gateway in this additional location. + |
+
+location+ +string + + |
+
+ Location: The location name of the additional region among Azure Data center regions. + |
+
+natGatewayState+ + +AdditionalLocation_NatGatewayState + + + |
+
+ NatGatewayState: Property can be used to enable NAT Gateway for this API Management service. + |
+
+publicIpAddressReference+ + +genruntime.ResourceReference + + + |
+
+ PublicIpAddressReference: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed +service in the location. Supported only for Premium SKU being deployed in Virtual Network. + |
+
+sku+ + +ApiManagementServiceSkuProperties + + + |
+
+ Sku: SKU properties of the API Management service. + |
+
+virtualNetworkConfiguration+ + +VirtualNetworkConfiguration + + + |
+
+ VirtualNetworkConfiguration: Virtual network configuration for the location. + |
+
+zones+ +[]string + + |
+
+ Zones: A list of availability zones denoting where the resource needs to come from. + |
+
+(Appears on:ApiManagementServiceProperties_ARM) +
+Description of an additional API Management resource location.
+| Field | +Description | +
|---|---|
+disableGateway+ +bool + + |
+
+ DisableGateway: Property only valid for an Api Management service deployed in multiple locations. This can be used to +disable the gateway in this additional location. + |
+
+location+ +string + + |
+
+ Location: The location name of the additional region among Azure Data center regions. + |
+
+natGatewayState+ + +AdditionalLocation_NatGatewayState + + + |
+
+ NatGatewayState: Property can be used to enable NAT Gateway for this API Management service. + |
+
+publicIpAddressId+ +string + + |
++ | +
+sku+ + +ApiManagementServiceSkuProperties_ARM + + + |
+
+ Sku: SKU properties of the API Management service. + |
+
+virtualNetworkConfiguration+ + +VirtualNetworkConfiguration_ARM + + + |
+
+ VirtualNetworkConfiguration: Virtual network configuration for the location. + |
+
+zones+ +[]string + + |
+
+ Zones: A list of availability zones denoting where the resource needs to come from. + |
+
string alias)+(Appears on:AdditionalLocation, AdditionalLocation_ARM) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
string alias)+(Appears on:AdditionalLocation_STATUS, AdditionalLocation_STATUS_ARM) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
string alias)+(Appears on:AdditionalLocation_STATUS, AdditionalLocation_STATUS_ARM) +
+| Value | +Description | +
|---|---|
"mtv1" |
++ |
"stv1" |
++ |
"stv2" |
++ |
"undetermined" |
++ |
+(Appears on:Service_STATUS) +
+Description of an additional API Management resource location.
+| Field | +Description | +
|---|---|
+disableGateway+ +bool + + |
+
+ DisableGateway: Property only valid for an Api Management service deployed in multiple locations. This can be used to +disable the gateway in this additional location. + |
+
+gatewayRegionalUrl+ +string + + |
+
+ GatewayRegionalUrl: Gateway URL of the API Management service in the Region. + |
+
+location+ +string + + |
+
+ Location: The location name of the additional region among Azure Data center regions. + |
+
+natGatewayState+ + +AdditionalLocation_NatGatewayState_STATUS + + + |
+
+ NatGatewayState: Property can be used to enable NAT Gateway for this API Management service. + |
+
+outboundPublicIPAddresses+ +[]string + + |
+
+ OutboundPublicIPAddresses: Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available +only for Premium SKU on stv2 platform. + |
+
+platformVersion+ + +AdditionalLocation_PlatformVersion_STATUS + + + |
+
+ PlatformVersion: Compute Platform Version running the service. + |
+
+privateIPAddresses+ +[]string + + |
+
+ PrivateIPAddresses: Private Static Load Balanced IP addresses of the API Management service which is deployed in an +Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated +SKU. + |
+
+publicIPAddresses+ +[]string + + |
+
+ PublicIPAddresses: Public Static Load Balanced IP addresses of the API Management service in the additional location. +Available only for Basic, Standard, Premium and Isolated SKU. + |
+
+publicIpAddressId+ +string + + |
+
+ PublicIpAddressId: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in +the location. Supported only for Premium SKU being deployed in Virtual Network. + |
+
+sku+ + +ApiManagementServiceSkuProperties_STATUS + + + |
+
+ Sku: SKU properties of the API Management service. + |
+
+virtualNetworkConfiguration+ + +VirtualNetworkConfiguration_STATUS + + + |
+
+ VirtualNetworkConfiguration: Virtual network configuration for the location. + |
+
+zones+ +[]string + + |
+
+ Zones: A list of availability zones denoting where the resource needs to come from. + |
+
+(Appears on:ApiManagementServiceProperties_STATUS_ARM) +
+Description of an additional API Management resource location.
+| Field | +Description | +
|---|---|
+disableGateway+ +bool + + |
+
+ DisableGateway: Property only valid for an Api Management service deployed in multiple locations. This can be used to +disable the gateway in this additional location. + |
+
+gatewayRegionalUrl+ +string + + |
+
+ GatewayRegionalUrl: Gateway URL of the API Management service in the Region. + |
+
+location+ +string + + |
+
+ Location: The location name of the additional region among Azure Data center regions. + |
+
+natGatewayState+ + +AdditionalLocation_NatGatewayState_STATUS + + + |
+
+ NatGatewayState: Property can be used to enable NAT Gateway for this API Management service. + |
+
+outboundPublicIPAddresses+ +[]string + + |
+
+ OutboundPublicIPAddresses: Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available +only for Premium SKU on stv2 platform. + |
+
+platformVersion+ + +AdditionalLocation_PlatformVersion_STATUS + + + |
+
+ PlatformVersion: Compute Platform Version running the service. + |
+
+privateIPAddresses+ +[]string + + |
+
+ PrivateIPAddresses: Private Static Load Balanced IP addresses of the API Management service which is deployed in an +Internal Virtual Network in a particular additional location. Available only for Basic, Standard, Premium and Isolated +SKU. + |
+
+publicIPAddresses+ +[]string + + |
+
+ PublicIPAddresses: Public Static Load Balanced IP addresses of the API Management service in the additional location. +Available only for Basic, Standard, Premium and Isolated SKU. + |
+
+publicIpAddressId+ +string + + |
+
+ PublicIpAddressId: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in +the location. Supported only for Premium SKU being deployed in Virtual Network. + |
+
+sku+ + +ApiManagementServiceSkuProperties_STATUS_ARM + + + |
+
+ Sku: SKU properties of the API Management service. + |
+
+virtualNetworkConfiguration+ + +VirtualNetworkConfiguration_STATUS_ARM + + + |
+
+ VirtualNetworkConfiguration: Virtual network configuration for the location. + |
+
+zones+ +[]string + + |
+
+ Zones: A list of availability zones denoting where the resource needs to come from. + |
+
+(Appears on:Service_Spec) +
+Identity properties of the Api Management service resource.
+| Field | +Description | +
|---|---|
+type+ + +ApiManagementServiceIdentity_Type + + + |
+
+ Type: The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly +created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the service. + |
+
+userAssignedIdentities+ + +[]UserAssignedIdentityDetails + + + |
+
+ UserAssignedIdentities: The list of user identities associated with 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:Service_Spec_ARM) +
+Identity properties of the Api Management service resource.
+| Field | +Description | +
|---|---|
+type+ + +ApiManagementServiceIdentity_Type + + + |
+
+ Type: The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly +created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the service. + |
+
+userAssignedIdentities+ + +map[string]./api/apimanagement/v1api20220801.UserAssignedIdentityDetails_ARM + + + |
++ | +
+(Appears on:Service_STATUS) +
+Identity properties of the Api Management service resource.
+| Field | +Description | +
|---|---|
+principalId+ +string + + |
+
+ PrincipalId: The principal id of the identity. + |
+
+tenantId+ +string + + |
+
+ TenantId: The client tenant id of the identity. + |
+
+type+ + +ApiManagementServiceIdentity_Type_STATUS + + + |
+
+ Type: The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly +created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the service. + |
+
+userAssignedIdentities+ + +map[string]./api/apimanagement/v1api20220801.UserIdentityProperties_STATUS + + + |
+
+ UserAssignedIdentities: The list of user identities associated with the resource. The user identity +dictionary key references will be ARM resource ids in the form: +‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ +providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’. + |
+
+(Appears on:Service_STATUS_ARM) +
+Identity properties of the Api Management service resource.
+| Field | +Description | +
|---|---|
+principalId+ +string + + |
+
+ PrincipalId: The principal id of the identity. + |
+
+tenantId+ +string + + |
+
+ TenantId: The client tenant id of the identity. + |
+
+type+ + +ApiManagementServiceIdentity_Type_STATUS + + + |
+
+ Type: The type of identity used for the resource. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly +created identity and a set of user assigned identities. The type ‘None’ will remove any identities from the service. + |
+
+userAssignedIdentities+ + +map[string]./api/apimanagement/v1api20220801.UserIdentityProperties_STATUS_ARM + + + |
+
+ UserAssignedIdentities: The list of user identities associated with the resource. The user identity +dictionary key references will be ARM resource ids in the form: +‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ +providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’. + |
+
string alias)+(Appears on:ApiManagementServiceIdentity, ApiManagementServiceIdentity_ARM) +
+| Value | +Description | +
|---|---|
"None" |
++ |
"SystemAssigned" |
++ |
"SystemAssigned, UserAssigned" |
++ |
"UserAssigned" |
++ |
string alias)+(Appears on:ApiManagementServiceIdentity_STATUS, ApiManagementServiceIdentity_STATUS_ARM) +
+| Value | +Description | +
|---|---|
"None" |
++ |
"SystemAssigned" |
++ |
"SystemAssigned, UserAssigned" |
++ |
"UserAssigned" |
++ |
+(Appears on:Service_Spec_ARM) +
+Properties of an API Management service resource description.
+| Field | +Description | +
|---|---|
+additionalLocations+ + +[]AdditionalLocation_ARM + + + |
+
+ AdditionalLocations: Additional datacenter locations of the API Management service. + |
+
+apiVersionConstraint+ + +ApiVersionConstraint_ARM + + + |
+
+ ApiVersionConstraint: Control Plane Apis version constraint for the API Management service. + |
+
+certificates+ + +[]CertificateConfiguration_ARM + + + |
+
+ Certificates: List of Certificates that need to be installed in the API Management service. Max supported certificates +that can be installed is 10. + |
+
+customProperties+ +map[string]string + + |
+
+ CustomProperties: Custom properties of the API Management service.Setting
+ |
+
+disableGateway+ +bool + + |
+
+ DisableGateway: Property only valid for an Api Management service deployed in multiple locations. This can be used to +disable the gateway in master region. + |
+
+enableClientCertificate+ +bool + + |
+
+ EnableClientCertificate: Property only meant to be used for Consumption SKU Service. This enforces a client certificate +to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the +policy on the gateway. + |
+
+hostnameConfigurations+ + +[]HostnameConfiguration_ARM + + + |
+
+ HostnameConfigurations: Custom hostname configuration of the API Management service. + |
+
+natGatewayState+ + +ApiManagementServiceProperties_NatGatewayState + + + |
+
+ NatGatewayState: Property can be used to enable NAT Gateway for this API Management service. + |
+
+notificationSenderEmail+ +string + + |
+
+ NotificationSenderEmail: Email address from which the notification will be sent. + |
+
+publicIpAddressId+ +string + + |
++ | +
+publicNetworkAccess+ + +ApiManagementServiceProperties_PublicNetworkAccess + + + |
+
+ PublicNetworkAccess: Whether or not public endpoint access is allowed for this API Management service. Value is +optional but if passed in, must be ‘Enabled’ or ‘Disabled’. If ‘Disabled’, private endpoints are the exclusive access +method. Default value is ‘Enabled’ + |
+
+publisherEmail+ +string + + |
+
+ PublisherEmail: Publisher email. + |
+
+publisherName+ +string + + |
+
+ PublisherName: Publisher name. + |
+
+restore+ +bool + + |
+
+ Restore: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True +all other properties will be ignored. + |
+
+virtualNetworkConfiguration+ + +VirtualNetworkConfiguration_ARM + + + |
+
+ VirtualNetworkConfiguration: Virtual network configuration of the API Management service. + |
+
+virtualNetworkType+ + +ApiManagementServiceProperties_VirtualNetworkType + + + |
+
+ VirtualNetworkType: The type of VPN in which API Management service needs to be configured in. None (Default Value) +means the API Management service is not part of any Virtual Network, External means the API Management deployment is set +up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is +setup inside a Virtual Network having an Intranet Facing Endpoint only. + |
+
string alias)+(Appears on:ApiManagementServiceProperties_ARM, Service_Spec) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
string alias)+(Appears on:ApiManagementServiceProperties_STATUS_ARM, Service_STATUS) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
string alias)+(Appears on:ApiManagementServiceProperties_STATUS_ARM, Service_STATUS) +
+| Value | +Description | +
|---|---|
"mtv1" |
++ |
"stv1" |
++ |
"stv2" |
++ |
"undetermined" |
++ |
string alias)+(Appears on:ApiManagementServiceProperties_ARM, Service_Spec) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
string alias)+(Appears on:ApiManagementServiceProperties_STATUS_ARM, Service_STATUS) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
+(Appears on:Service_STATUS_ARM) +
+Properties of an API Management service resource description.
+| Field | +Description | +
|---|---|
+additionalLocations+ + +[]AdditionalLocation_STATUS_ARM + + + |
+
+ AdditionalLocations: Additional datacenter locations of the API Management service. + |
+
+apiVersionConstraint+ + +ApiVersionConstraint_STATUS_ARM + + + |
+
+ ApiVersionConstraint: Control Plane Apis version constraint for the API Management service. + |
+
+certificates+ + +[]CertificateConfiguration_STATUS_ARM + + + |
+
+ Certificates: List of Certificates that need to be installed in the API Management service. Max supported certificates +that can be installed is 10. + |
+
+createdAtUtc+ +string + + |
+
+ CreatedAtUtc: Creation UTC date of the API Management service.The date conforms to the following format:
+ |
+
+customProperties+ +map[string]string + + |
+
+ CustomProperties: Custom properties of the API Management service.Setting
+ |
+
+developerPortalUrl+ +string + + |
+
+ DeveloperPortalUrl: DEveloper Portal endpoint URL of the API Management service. + |
+
+disableGateway+ +bool + + |
+
+ DisableGateway: Property only valid for an Api Management service deployed in multiple locations. This can be used to +disable the gateway in master region. + |
+
+enableClientCertificate+ +bool + + |
+
+ EnableClientCertificate: Property only meant to be used for Consumption SKU Service. This enforces a client certificate +to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the +policy on the gateway. + |
+
+gatewayRegionalUrl+ +string + + |
+
+ GatewayRegionalUrl: Gateway URL of the API Management service in the Default Region. + |
+
+gatewayUrl+ +string + + |
+
+ GatewayUrl: Gateway URL of the API Management service. + |
+
+hostnameConfigurations+ + +[]HostnameConfiguration_STATUS_ARM + + + |
+
+ HostnameConfigurations: Custom hostname configuration of the API Management service. + |
+
+managementApiUrl+ +string + + |
+
+ ManagementApiUrl: Management API endpoint URL of the API Management service. + |
+
+natGatewayState+ + +ApiManagementServiceProperties_NatGatewayState_STATUS + + + |
+
+ NatGatewayState: Property can be used to enable NAT Gateway for this API Management service. + |
+
+notificationSenderEmail+ +string + + |
+
+ NotificationSenderEmail: Email address from which the notification will be sent. + |
+
+outboundPublicIPAddresses+ +[]string + + |
+
+ OutboundPublicIPAddresses: Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available +only for Premium SKU on stv2 platform. + |
+
+platformVersion+ + +ApiManagementServiceProperties_PlatformVersion_STATUS + + + |
+
+ PlatformVersion: Compute Platform Version running the service in this location. + |
+
+portalUrl+ +string + + |
+
+ PortalUrl: Publisher portal endpoint Url of the API Management service. + |
+
+privateEndpointConnections+ + +[]RemotePrivateEndpointConnectionWrapper_STATUS_ARM + + + |
+
+ PrivateEndpointConnections: List of Private Endpoint Connections of this service. + |
+
+privateIPAddresses+ +[]string + + |
+
+ PrivateIPAddresses: Private Static Load Balanced IP addresses of the API Management service in Primary region which is +deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU. + |
+
+provisioningState+ +string + + |
+
+ ProvisioningState: The current provisioning state of the API Management service which can be one of the following: +Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. + |
+
+publicIPAddresses+ +[]string + + |
+
+ PublicIPAddresses: Public Static Load Balanced IP addresses of the API Management service in Primary region. Available +only for Basic, Standard, Premium and Isolated SKU. + |
+
+publicIpAddressId+ +string + + |
+
+ PublicIpAddressId: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in +the region. Supported only for Developer and Premium SKU being deployed in Virtual Network. + |
+
+publicNetworkAccess+ + +ApiManagementServiceProperties_PublicNetworkAccess_STATUS + + + |
+
+ PublicNetworkAccess: Whether or not public endpoint access is allowed for this API Management service. Value is +optional but if passed in, must be ‘Enabled’ or ‘Disabled’. If ‘Disabled’, private endpoints are the exclusive access +method. Default value is ‘Enabled’ + |
+
+publisherEmail+ +string + + |
+
+ PublisherEmail: Publisher email. + |
+
+publisherName+ +string + + |
+
+ PublisherName: Publisher name. + |
+
+restore+ +bool + + |
+
+ Restore: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True +all other properties will be ignored. + |
+
+scmUrl+ +string + + |
+
+ ScmUrl: SCM endpoint URL of the API Management service. + |
+
+targetProvisioningState+ +string + + |
+
+ TargetProvisioningState: The provisioning state of the API Management service, which is targeted by the long running +operation started on the service. + |
+
+virtualNetworkConfiguration+ + +VirtualNetworkConfiguration_STATUS_ARM + + + |
+
+ VirtualNetworkConfiguration: Virtual network configuration of the API Management service. + |
+
+virtualNetworkType+ + +ApiManagementServiceProperties_VirtualNetworkType_STATUS + + + |
+
+ VirtualNetworkType: The type of VPN in which API Management service needs to be configured in. None (Default Value) +means the API Management service is not part of any Virtual Network, External means the API Management deployment is set +up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is +setup inside a Virtual Network having an Intranet Facing Endpoint only. + |
+
string alias)+(Appears on:ApiManagementServiceProperties_ARM, Service_Spec) +
+| Value | +Description | +
|---|---|
"External" |
++ |
"Internal" |
++ |
"None" |
++ |
string alias)+(Appears on:ApiManagementServiceProperties_STATUS_ARM, Service_STATUS) +
+| Value | +Description | +
|---|---|
"External" |
++ |
"Internal" |
++ |
"None" |
++ |
+(Appears on:AdditionalLocation, Service_Spec) +
+API Management service resource SKU properties.
+| Field | +Description | +
|---|---|
+capacity+ +int + + |
+
+ Capacity: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. + |
+
+name+ + +ApiManagementServiceSkuProperties_Name + + + |
+
+ Name: Name of the Sku. + |
+
+(Appears on:AdditionalLocation_ARM, Service_Spec_ARM) +
+API Management service resource SKU properties.
+| Field | +Description | +
|---|---|
+capacity+ +int + + |
+
+ Capacity: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. + |
+
+name+ + +ApiManagementServiceSkuProperties_Name + + + |
+
+ Name: Name of the Sku. + |
+
string alias)+(Appears on:ApiManagementServiceSkuProperties, ApiManagementServiceSkuProperties_ARM) +
+| Value | +Description | +
|---|---|
"Basic" |
++ |
"Consumption" |
++ |
"Developer" |
++ |
"Isolated" |
++ |
"Premium" |
++ |
"Standard" |
++ |
string alias)+(Appears on:ApiManagementServiceSkuProperties_STATUS, ApiManagementServiceSkuProperties_STATUS_ARM) +
+| Value | +Description | +
|---|---|
"Basic" |
++ |
"Consumption" |
++ |
"Developer" |
++ |
"Isolated" |
++ |
"Premium" |
++ |
"Standard" |
++ |
+(Appears on:AdditionalLocation_STATUS, Service_STATUS) +
+API Management service resource SKU properties.
+| Field | +Description | +
|---|---|
+capacity+ +int + + |
+
+ Capacity: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. + |
+
+name+ + +ApiManagementServiceSkuProperties_Name_STATUS + + + |
+
+ Name: Name of the Sku. + |
+
+(Appears on:AdditionalLocation_STATUS_ARM, Service_STATUS_ARM) +
+API Management service resource SKU properties.
+| Field | +Description | +
|---|---|
+capacity+ +int + + |
+
+ Capacity: Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. + |
+
+name+ + +ApiManagementServiceSkuProperties_Name_STATUS + + + |
+
+ Name: Name of the Sku. + |
+
+(Appears on:Service_Spec) +
+Control Plane Apis version constraint for the API Management service.
+| Field | +Description | +
|---|---|
+minApiVersion+ +string + + |
+
+ MinApiVersion: Limit control plane API calls to API Management service with version equal to or newer than this value. + |
+
+(Appears on:ApiManagementServiceProperties_ARM) +
+Control Plane Apis version constraint for the API Management service.
+| Field | +Description | +
|---|---|
+minApiVersion+ +string + + |
+
+ MinApiVersion: Limit control plane API calls to API Management service with version equal to or newer than this value. + |
+
+(Appears on:Service_STATUS) +
+Control Plane Apis version constraint for the API Management service.
+| Field | +Description | +
|---|---|
+minApiVersion+ +string + + |
+
+ MinApiVersion: Limit control plane API calls to API Management service with version equal to or newer than this value. + |
+
+(Appears on:ApiManagementServiceProperties_STATUS_ARM) +
+Control Plane Apis version constraint for the API Management service.
+| Field | +Description | +
|---|---|
+minApiVersion+ +string + + |
+
+ MinApiVersion: Limit control plane API calls to API Management service with version equal to or newer than this value. + |
+
+(Appears on:RemotePrivateEndpointConnectionWrapper_STATUS) +
+A wrapper for an ARM resource id
+| Field | +Description | +
|---|---|
+id+ +string + + |
++ | +
+(Appears on:PrivateEndpointConnectionWrapperProperties_STATUS_ARM) +
+A wrapper for an ARM resource id
+| Field | +Description | +
|---|---|
+id+ +string + + |
++ | +
+(Appears on:Service_Spec) +
+Certificate configuration which consist of non-trusted intermediates and root certificates.
+| Field | +Description | +
|---|---|
+certificate+ + +CertificateInformation + + + |
+
+ Certificate: Certificate information. + |
+
+certificatePassword+ + +genruntime.SecretReference + + + |
+
+ CertificatePassword: Certificate Password. + |
+
+encodedCertificate+ +string + + |
+
+ EncodedCertificate: Base64 Encoded certificate. + |
+
+storeName+ + +CertificateConfiguration_StoreName + + + |
+
+ StoreName: The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and +CertificateAuthority are valid locations. + |
+
+(Appears on:ApiManagementServiceProperties_ARM) +
+Certificate configuration which consist of non-trusted intermediates and root certificates.
+| Field | +Description | +
|---|---|
+certificate+ + +CertificateInformation_ARM + + + |
+
+ Certificate: Certificate information. + |
+
+certificatePassword+ +string + + |
+
+ CertificatePassword: Certificate Password. + |
+
+encodedCertificate+ +string + + |
+
+ EncodedCertificate: Base64 Encoded certificate. + |
+
+storeName+ + +CertificateConfiguration_StoreName + + + |
+
+ StoreName: The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and +CertificateAuthority are valid locations. + |
+
+(Appears on:Service_STATUS) +
+Certificate configuration which consist of non-trusted intermediates and root certificates.
+| Field | +Description | +
|---|---|
+certificate+ + +CertificateInformation_STATUS + + + |
+
+ Certificate: Certificate information. + |
+
+encodedCertificate+ +string + + |
+
+ EncodedCertificate: Base64 Encoded certificate. + |
+
+storeName+ + +CertificateConfiguration_StoreName_STATUS + + + |
+
+ StoreName: The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and +CertificateAuthority are valid locations. + |
+
+(Appears on:ApiManagementServiceProperties_STATUS_ARM) +
+Certificate configuration which consist of non-trusted intermediates and root certificates.
+| Field | +Description | +
|---|---|
+certificate+ + +CertificateInformation_STATUS_ARM + + + |
+
+ Certificate: Certificate information. + |
+
+encodedCertificate+ +string + + |
+
+ EncodedCertificate: Base64 Encoded certificate. + |
+
+storeName+ + +CertificateConfiguration_StoreName_STATUS + + + |
+
+ StoreName: The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and +CertificateAuthority are valid locations. + |
+
string alias)+(Appears on:CertificateConfiguration, CertificateConfiguration_ARM) +
+| Value | +Description | +
|---|---|
"CertificateAuthority" |
++ |
"Root" |
++ |
string alias)+(Appears on:CertificateConfiguration_STATUS, CertificateConfiguration_STATUS_ARM) +
+| Value | +Description | +
|---|---|
"CertificateAuthority" |
++ |
"Root" |
++ |
+(Appears on:CertificateConfiguration, HostnameConfiguration) +
+SSL certificate information.
+| Field | +Description | +
|---|---|
+expiry+ +string + + |
+
+ Expiry: Expiration date of the certificate. The date conforms to the following format: |
+
+expiryFromConfig+ + +genruntime.ConfigMapReference + + + |
+
+ ExpiryFromConfig: Expiration date of the certificate. The date conforms to the following format: |
+
+subject+ +string + + |
+
+ Subject: Subject of the certificate. + |
+
+subjectFromConfig+ + +genruntime.ConfigMapReference + + + |
+
+ SubjectFromConfig: Subject of the certificate. + |
+
+thumbprint+ +string + + |
+
+ Thumbprint: Thumbprint of the certificate. + |
+
+thumbprintFromConfig+ + +genruntime.ConfigMapReference + + + |
+
+ ThumbprintFromConfig: Thumbprint of the certificate. + |
+
+(Appears on:CertificateConfiguration_ARM, HostnameConfiguration_ARM) +
+SSL certificate information.
+| Field | +Description | +
|---|---|
+expiry+ +string + + |
+
+ Expiry: Expiration date of the certificate. The date conforms to the following format: |
+
+subject+ +string + + |
+
+ Subject: Subject of the certificate. + |
+
+thumbprint+ +string + + |
+
+ Thumbprint: Thumbprint of the certificate. + |
+
+(Appears on:CertificateConfiguration_STATUS, HostnameConfiguration_STATUS) +
+SSL certificate information.
+| Field | +Description | +
|---|---|
+expiry+ +string + + |
+
+ Expiry: Expiration date of the certificate. The date conforms to the following format: |
+
+subject+ +string + + |
+
+ Subject: Subject of the certificate. + |
+
+thumbprint+ +string + + |
+
+ Thumbprint: Thumbprint of the certificate. + |
+
+(Appears on:CertificateConfiguration_STATUS_ARM, HostnameConfiguration_STATUS_ARM) +
+SSL certificate information.
+| Field | +Description | +
|---|---|
+expiry+ +string + + |
+
+ Expiry: Expiration date of the certificate. The date conforms to the following format: |
+
+subject+ +string + + |
+
+ Subject: Subject of the certificate. + |
+
+thumbprint+ +string + + |
+
+ Thumbprint: Thumbprint of the certificate. + |
+
+(Appears on:Service_Spec) +
+Custom hostname configuration.
+| Field | +Description | +
|---|---|
+certificate+ + +CertificateInformation + + + |
+
+ Certificate: Certificate information. + |
+
+certificatePassword+ + +genruntime.SecretReference + + + |
+
+ CertificatePassword: Certificate Password. + |
+
+certificateSource+ + +HostnameConfiguration_CertificateSource + + + |
+
+ CertificateSource: Certificate Source. + |
+
+certificateStatus+ + +HostnameConfiguration_CertificateStatus + + + |
+
+ CertificateStatus: Certificate Status. + |
+
+defaultSslBinding+ +bool + + |
+
+ DefaultSslBinding: Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. +If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is +useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The +setting only applied to gateway Hostname Type. + |
+
+encodedCertificate+ +string + + |
+
+ EncodedCertificate: Base64 Encoded certificate. + |
+
+hostName+ +string + + |
+
+ HostName: Hostname to configure on the Api Management service. + |
+
+identityClientId+ +string + + |
+
+ IdentityClientId: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to +the keyVault containing the SSL certificate. + |
+
+identityClientIdFromConfig+ + +genruntime.ConfigMapReference + + + |
+
+ IdentityClientIdFromConfig: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET +access to the keyVault containing the SSL certificate. + |
+
+keyVaultId+ +string + + |
+
+ KeyVaultId: Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, +auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. +The secret should be of type application/x-pkcs12 + |
+
+negotiateClientCertificate+ +bool + + |
+
+ NegotiateClientCertificate: Specify true to always negotiate client certificate on the hostname. Default Value is false. + |
+
+type+ + +HostnameConfiguration_Type + + + |
+
+ Type: Hostname type. + |
+
+(Appears on:ApiManagementServiceProperties_ARM) +
+Custom hostname configuration.
+| Field | +Description | +
|---|---|
+certificate+ + +CertificateInformation_ARM + + + |
+
+ Certificate: Certificate information. + |
+
+certificatePassword+ +string + + |
+
+ CertificatePassword: Certificate Password. + |
+
+certificateSource+ + +HostnameConfiguration_CertificateSource + + + |
+
+ CertificateSource: Certificate Source. + |
+
+certificateStatus+ + +HostnameConfiguration_CertificateStatus + + + |
+
+ CertificateStatus: Certificate Status. + |
+
+defaultSslBinding+ +bool + + |
+
+ DefaultSslBinding: Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. +If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is +useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The +setting only applied to gateway Hostname Type. + |
+
+encodedCertificate+ +string + + |
+
+ EncodedCertificate: Base64 Encoded certificate. + |
+
+hostName+ +string + + |
+
+ HostName: Hostname to configure on the Api Management service. + |
+
+identityClientId+ +string + + |
+
+ IdentityClientId: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to +the keyVault containing the SSL certificate. + |
+
+keyVaultId+ +string + + |
+
+ KeyVaultId: Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, +auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. +The secret should be of type application/x-pkcs12 + |
+
+negotiateClientCertificate+ +bool + + |
+
+ NegotiateClientCertificate: Specify true to always negotiate client certificate on the hostname. Default Value is false. + |
+
+type+ + +HostnameConfiguration_Type + + + |
+
+ Type: Hostname type. + |
+
string alias)+(Appears on:HostnameConfiguration, HostnameConfiguration_ARM) +
+| Value | +Description | +
|---|---|
"BuiltIn" |
++ |
"Custom" |
++ |
"KeyVault" |
++ |
"Managed" |
++ |
string alias)+(Appears on:HostnameConfiguration_STATUS, HostnameConfiguration_STATUS_ARM) +
+| Value | +Description | +
|---|---|
"BuiltIn" |
++ |
"Custom" |
++ |
"KeyVault" |
++ |
"Managed" |
++ |
string alias)+(Appears on:HostnameConfiguration, HostnameConfiguration_ARM) +
+| Value | +Description | +
|---|---|
"Completed" |
++ |
"Failed" |
++ |
"InProgress" |
++ |
string alias)+(Appears on:HostnameConfiguration_STATUS, HostnameConfiguration_STATUS_ARM) +
+| Value | +Description | +
|---|---|
"Completed" |
++ |
"Failed" |
++ |
"InProgress" |
++ |
+(Appears on:Service_STATUS) +
+Custom hostname configuration.
+| Field | +Description | +
|---|---|
+certificate+ + +CertificateInformation_STATUS + + + |
+
+ Certificate: Certificate information. + |
+
+certificateSource+ + +HostnameConfiguration_CertificateSource_STATUS + + + |
+
+ CertificateSource: Certificate Source. + |
+
+certificateStatus+ + +HostnameConfiguration_CertificateStatus_STATUS + + + |
+
+ CertificateStatus: Certificate Status. + |
+
+defaultSslBinding+ +bool + + |
+
+ DefaultSslBinding: Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. +If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is +useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The +setting only applied to gateway Hostname Type. + |
+
+encodedCertificate+ +string + + |
+
+ EncodedCertificate: Base64 Encoded certificate. + |
+
+hostName+ +string + + |
+
+ HostName: Hostname to configure on the Api Management service. + |
+
+identityClientId+ +string + + |
+
+ IdentityClientId: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to +the keyVault containing the SSL certificate. + |
+
+keyVaultId+ +string + + |
+
+ KeyVaultId: Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, +auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. +The secret should be of type application/x-pkcs12 + |
+
+negotiateClientCertificate+ +bool + + |
+
+ NegotiateClientCertificate: Specify true to always negotiate client certificate on the hostname. Default Value is false. + |
+
+type+ + +HostnameConfiguration_Type_STATUS + + + |
+
+ Type: Hostname type. + |
+
+(Appears on:ApiManagementServiceProperties_STATUS_ARM) +
+Custom hostname configuration.
+| Field | +Description | +
|---|---|
+certificate+ + +CertificateInformation_STATUS_ARM + + + |
+
+ Certificate: Certificate information. + |
+
+certificateSource+ + +HostnameConfiguration_CertificateSource_STATUS + + + |
+
+ CertificateSource: Certificate Source. + |
+
+certificateStatus+ + +HostnameConfiguration_CertificateStatus_STATUS + + + |
+
+ CertificateStatus: Certificate Status. + |
+
+defaultSslBinding+ +bool + + |
+
+ DefaultSslBinding: Specify true to setup the certificate associated with this Hostname as the Default SSL Certificate. +If a client does not send the SNI header, then this will be the certificate that will be challenged. The property is +useful if a service has multiple custom hostname enabled and it needs to decide on the default ssl certificate. The +setting only applied to gateway Hostname Type. + |
+
+encodedCertificate+ +string + + |
+
+ EncodedCertificate: Base64 Encoded certificate. + |
+
+hostName+ +string + + |
+
+ HostName: Hostname to configure on the Api Management service. + |
+
+identityClientId+ +string + + |
+
+ IdentityClientId: System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to +the keyVault containing the SSL certificate. + |
+
+keyVaultId+ +string + + |
+
+ KeyVaultId: Url to the KeyVault Secret containing the Ssl Certificate. If absolute Url containing version is provided, +auto-update of ssl certificate will not work. This requires Api Management service to be configured with aka.ms/apimmsi. +The secret should be of type application/x-pkcs12 + |
+
+negotiateClientCertificate+ +bool + + |
+
+ NegotiateClientCertificate: Specify true to always negotiate client certificate on the hostname. Default Value is false. + |
+
+type+ + +HostnameConfiguration_Type_STATUS + + + |
+
+ Type: Hostname type. + |
+
string alias)+(Appears on:HostnameConfiguration, HostnameConfiguration_ARM) +
+| Value | +Description | +
|---|---|
"DeveloperPortal" |
++ |
"Management" |
++ |
"Portal" |
++ |
"Proxy" |
++ |
"Scm" |
++ |
string alias)+(Appears on:HostnameConfiguration_STATUS, HostnameConfiguration_STATUS_ARM) +
+| Value | +Description | +
|---|---|
"DeveloperPortal" |
++ |
"Management" |
++ |
"Portal" |
++ |
"Proxy" |
++ |
"Scm" |
++ |
+(Appears on:RemotePrivateEndpointConnectionWrapper_STATUS_ARM) +
+Properties of the PrivateEndpointConnectProperties.
+| Field | +Description | +
|---|---|
+groupIds+ +[]string + + |
+
+ GroupIds: All the Group ids. + |
+
+privateEndpoint+ + +ArmIdWrapper_STATUS_ARM + + + |
+
+ PrivateEndpoint: The resource of private end point. + |
+
+privateLinkServiceConnectionState+ + +PrivateLinkServiceConnectionState_STATUS_ARM + + + |
+
+ PrivateLinkServiceConnectionState: A collection of information about the state of the connection between service +consumer and provider. + |
+
+provisioningState+ +string + + |
+
+ ProvisioningState: The provisioning state of the private endpoint connection resource. + |
+
string alias)+(Appears on:PrivateLinkServiceConnectionState_STATUS, PrivateLinkServiceConnectionState_STATUS_ARM) +
+The private endpoint connection status.
+| Value | +Description | +
|---|---|
"Approved" |
++ |
"Pending" |
++ |
"Rejected" |
++ |
+(Appears on:RemotePrivateEndpointConnectionWrapper_STATUS) +
+A collection of information about the state of the connection between service consumer and provider.
+| Field | +Description | +
|---|---|
+actionsRequired+ +string + + |
+
+ ActionsRequired: A message indicating if changes on the service provider require any updates on the consumer. + |
+
+description+ +string + + |
+
+ Description: The reason for approval/rejection of the connection. + |
+
+status+ + +PrivateEndpointServiceConnectionStatus_STATUS + + + |
+
+ Status: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. + |
+
+(Appears on:PrivateEndpointConnectionWrapperProperties_STATUS_ARM) +
+A collection of information about the state of the connection between service consumer and provider.
+| Field | +Description | +
|---|---|
+actionsRequired+ +string + + |
+
+ ActionsRequired: A message indicating if changes on the service provider require any updates on the consumer. + |
+
+description+ +string + + |
+
+ Description: The reason for approval/rejection of the connection. + |
+
+status+ + +PrivateEndpointServiceConnectionStatus_STATUS + + + |
+
+ Status: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. + |
+
+(Appears on:Service_STATUS) +
+Remote Private Endpoint Connection resource.
+| Field | +Description | +
|---|---|
+groupIds+ +[]string + + |
+
+ GroupIds: All the Group ids. + |
+
+id+ +string + + |
+
+ Id: Private Endpoint connection resource id + |
+
+name+ +string + + |
+
+ Name: Private Endpoint Connection Name + |
+
+privateEndpoint+ + +ArmIdWrapper_STATUS + + + |
+
+ PrivateEndpoint: The resource of private end point. + |
+
+privateLinkServiceConnectionState+ + +PrivateLinkServiceConnectionState_STATUS + + + |
+
+ PrivateLinkServiceConnectionState: A collection of information about the state of the connection between service +consumer and provider. + |
+
+provisioningState+ +string + + |
+
+ ProvisioningState: The provisioning state of the private endpoint connection resource. + |
+
+type+ +string + + |
+
+ Type: Private Endpoint Connection Resource Type + |
+
+(Appears on:ApiManagementServiceProperties_STATUS_ARM) +
+Remote Private Endpoint Connection resource.
+| Field | +Description | +
|---|---|
+id+ +string + + |
+
+ Id: Private Endpoint connection resource id + |
+
+name+ +string + + |
+
+ Name: Private Endpoint Connection Name + |
+
+properties+ + +PrivateEndpointConnectionWrapperProperties_STATUS_ARM + + + |
+
+ Properties: Resource properties. + |
+
+type+ +string + + |
+
+ Type: Private Endpoint Connection Resource Type + |
+
Generator information: +- Generated from: /apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/apimdeployment.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName} +
| Field | +Description | +||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||||||||||||||||||||||||||||
+spec+ + +Service_Spec + + + |
+
+ + +
|
+||||||||||||||||||||||||||||||||||||||||||||||
+status+ + +Service_STATUS + + + |
++ | +
+(Appears on:Service) +
+| Field | +Description | +
|---|---|
+additionalLocations+ + +[]AdditionalLocation_STATUS + + + |
+
+ AdditionalLocations: Additional datacenter locations of the API Management service. + |
+
+apiVersionConstraint+ + +ApiVersionConstraint_STATUS + + + |
+
+ ApiVersionConstraint: Control Plane Apis version constraint for the API Management service. + |
+
+certificates+ + +[]CertificateConfiguration_STATUS + + + |
+
+ Certificates: List of Certificates that need to be installed in the API Management service. Max supported certificates +that can be installed is 10. + |
+
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+createdAtUtc+ +string + + |
+
+ CreatedAtUtc: Creation UTC date of the API Management service.The date conforms to the following format:
+ |
+
+customProperties+ +map[string]string + + |
+
+ CustomProperties: Custom properties of the API Management service.Setting
+ |
+
+developerPortalUrl+ +string + + |
+
+ DeveloperPortalUrl: DEveloper Portal endpoint URL of the API Management service. + |
+
+disableGateway+ +bool + + |
+
+ DisableGateway: Property only valid for an Api Management service deployed in multiple locations. This can be used to +disable the gateway in master region. + |
+
+enableClientCertificate+ +bool + + |
+
+ EnableClientCertificate: Property only meant to be used for Consumption SKU Service. This enforces a client certificate +to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the +policy on the gateway. + |
+
+etag+ +string + + |
+
+ Etag: ETag of the resource. + |
+
+gatewayRegionalUrl+ +string + + |
+
+ GatewayRegionalUrl: Gateway URL of the API Management service in the Default Region. + |
+
+gatewayUrl+ +string + + |
+
+ GatewayUrl: Gateway URL of the API Management service. + |
+
+hostnameConfigurations+ + +[]HostnameConfiguration_STATUS + + + |
+
+ HostnameConfigurations: Custom hostname configuration of the API Management service. + |
+
+id+ +string + + |
+
+ Id: Resource ID. + |
+
+identity+ + +ApiManagementServiceIdentity_STATUS + + + |
+
+ Identity: Managed service identity of the Api Management service. + |
+
+location+ +string + + |
+
+ Location: Resource location. + |
+
+managementApiUrl+ +string + + |
+
+ ManagementApiUrl: Management API endpoint URL of the API Management service. + |
+
+name+ +string + + |
+
+ Name: Resource name. + |
+
+natGatewayState+ + +ApiManagementServiceProperties_NatGatewayState_STATUS + + + |
+
+ NatGatewayState: Property can be used to enable NAT Gateway for this API Management service. + |
+
+notificationSenderEmail+ +string + + |
+
+ NotificationSenderEmail: Email address from which the notification will be sent. + |
+
+outboundPublicIPAddresses+ +[]string + + |
+
+ OutboundPublicIPAddresses: Outbound public IPV4 address prefixes associated with NAT Gateway deployed service. Available +only for Premium SKU on stv2 platform. + |
+
+platformVersion+ + +ApiManagementServiceProperties_PlatformVersion_STATUS + + + |
+
+ PlatformVersion: Compute Platform Version running the service in this location. + |
+
+portalUrl+ +string + + |
+
+ PortalUrl: Publisher portal endpoint Url of the API Management service. + |
+
+privateEndpointConnections+ + +[]RemotePrivateEndpointConnectionWrapper_STATUS + + + |
+
+ PrivateEndpointConnections: List of Private Endpoint Connections of this service. + |
+
+privateIPAddresses+ +[]string + + |
+
+ PrivateIPAddresses: Private Static Load Balanced IP addresses of the API Management service in Primary region which is +deployed in an Internal Virtual Network. Available only for Basic, Standard, Premium and Isolated SKU. + |
+
+provisioningState+ +string + + |
+
+ ProvisioningState: The current provisioning state of the API Management service which can be one of the following: +Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. + |
+
+publicIPAddresses+ +[]string + + |
+
+ PublicIPAddresses: Public Static Load Balanced IP addresses of the API Management service in Primary region. Available +only for Basic, Standard, Premium and Isolated SKU. + |
+
+publicIpAddressId+ +string + + |
+
+ PublicIpAddressId: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed service in +the region. Supported only for Developer and Premium SKU being deployed in Virtual Network. + |
+
+publicNetworkAccess+ + +ApiManagementServiceProperties_PublicNetworkAccess_STATUS + + + |
+
+ PublicNetworkAccess: Whether or not public endpoint access is allowed for this API Management service. Value is +optional but if passed in, must be ‘Enabled’ or ‘Disabled’. If ‘Disabled’, private endpoints are the exclusive access +method. Default value is ‘Enabled’ + |
+
+publisherEmail+ +string + + |
+
+ PublisherEmail: Publisher email. + |
+
+publisherName+ +string + + |
+
+ PublisherName: Publisher name. + |
+
+restore+ +bool + + |
+
+ Restore: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True +all other properties will be ignored. + |
+
+scmUrl+ +string + + |
+
+ ScmUrl: SCM endpoint URL of the API Management service. + |
+
+sku+ + +ApiManagementServiceSkuProperties_STATUS + + + |
+
+ Sku: SKU properties of the API Management service. + |
+
+systemData+ + +SystemData_STATUS + + + |
+
+ SystemData: Metadata pertaining to creation and last modification of the resource. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+targetProvisioningState+ +string + + |
+
+ TargetProvisioningState: The provisioning state of the API Management service, which is targeted by the long running +operation started on the service. + |
+
+type+ +string + + |
+
+ Type: Resource type for API Management resource is set to Microsoft.ApiManagement. + |
+
+virtualNetworkConfiguration+ + +VirtualNetworkConfiguration_STATUS + + + |
+
+ VirtualNetworkConfiguration: Virtual network configuration of the API Management service. + |
+
+virtualNetworkType+ + +ApiManagementServiceProperties_VirtualNetworkType_STATUS + + + |
+
+ VirtualNetworkType: The type of VPN in which API Management service needs to be configured in. None (Default Value) +means the API Management service is not part of any Virtual Network, External means the API Management deployment is set +up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is +setup inside a Virtual Network having an Intranet Facing Endpoint only. + |
+
+zones+ +[]string + + |
+
+ Zones: A list of availability zones denoting where the resource needs to come from. + |
+
| Field | +Description | +
|---|---|
+etag+ +string + + |
+
+ Etag: ETag of the resource. + |
+
+id+ +string + + |
+
+ Id: Resource ID. + |
+
+identity+ + +ApiManagementServiceIdentity_STATUS_ARM + + + |
+
+ Identity: Managed service identity of the Api Management service. + |
+
+location+ +string + + |
+
+ Location: Resource location. + |
+
+name+ +string + + |
+
+ Name: Resource name. + |
+
+properties+ + +ApiManagementServiceProperties_STATUS_ARM + + + |
+
+ Properties: Properties of the API Management service. + |
+
+sku+ + +ApiManagementServiceSkuProperties_STATUS_ARM + + + |
+
+ Sku: SKU properties of the API Management service. + |
+
+systemData+ + +SystemData_STATUS_ARM + + + |
+
+ SystemData: Metadata pertaining to creation and last modification of the resource. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+type+ +string + + |
+
+ Type: Resource type for API Management resource is set to Microsoft.ApiManagement. + |
+
+zones+ +[]string + + |
+
+ Zones: A list of availability zones denoting where the resource needs to come from. + |
+
+(Appears on:Service) +
+| Field | +Description | +
|---|---|
+additionalLocations+ + +[]AdditionalLocation + + + |
+
+ AdditionalLocations: Additional datacenter locations of the API Management service. + |
+
+apiVersionConstraint+ + +ApiVersionConstraint + + + |
+
+ ApiVersionConstraint: Control Plane Apis version constraint for the API Management service. + |
+
+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. + |
+
+certificates+ + +[]CertificateConfiguration + + + |
+
+ Certificates: List of Certificates that need to be installed in the API Management service. Max supported certificates +that can be installed is 10. + |
+
+customProperties+ +map[string]string + + |
+
+ CustomProperties: Custom properties of the API Management service.Setting
+ |
+
+disableGateway+ +bool + + |
+
+ DisableGateway: Property only valid for an Api Management service deployed in multiple locations. This can be used to +disable the gateway in master region. + |
+
+enableClientCertificate+ +bool + + |
+
+ EnableClientCertificate: Property only meant to be used for Consumption SKU Service. This enforces a client certificate +to be presented on each request to the gateway. This also enables the ability to authenticate the certificate in the +policy on the gateway. + |
+
+hostnameConfigurations+ + +[]HostnameConfiguration + + + |
+
+ HostnameConfigurations: Custom hostname configuration of the API Management service. + |
+
+identity+ + +ApiManagementServiceIdentity + + + |
+
+ Identity: Managed service identity of the Api Management service. + |
+
+location+ +string + + |
+
+ Location: Resource location. + |
+
+natGatewayState+ + +ApiManagementServiceProperties_NatGatewayState + + + |
+
+ NatGatewayState: Property can be used to enable NAT Gateway for this API Management service. + |
+
+notificationSenderEmail+ +string + + |
+
+ NotificationSenderEmail: Email address from which the notification will be sent. + |
+
+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 + |
+
+publicIpAddressReference+ + +genruntime.ResourceReference + + + |
+
+ PublicIpAddressReference: Public Standard SKU IP V4 based IP address to be associated with Virtual Network deployed +service in the region. Supported only for Developer and Premium SKU being deployed in Virtual Network. + |
+
+publicNetworkAccess+ + +ApiManagementServiceProperties_PublicNetworkAccess + + + |
+
+ PublicNetworkAccess: Whether or not public endpoint access is allowed for this API Management service. Value is +optional but if passed in, must be ‘Enabled’ or ‘Disabled’. If ‘Disabled’, private endpoints are the exclusive access +method. Default value is ‘Enabled’ + |
+
+publisherEmail+ +string + + |
+
+ PublisherEmail: Publisher email. + |
+
+publisherName+ +string + + |
+
+ PublisherName: Publisher name. + |
+
+restore+ +bool + + |
+
+ Restore: Undelete Api Management Service if it was previously soft-deleted. If this flag is specified and set to True +all other properties will be ignored. + |
+
+sku+ + +ApiManagementServiceSkuProperties + + + |
+
+ Sku: SKU properties of the API Management service. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+virtualNetworkConfiguration+ + +VirtualNetworkConfiguration + + + |
+
+ VirtualNetworkConfiguration: Virtual network configuration of the API Management service. + |
+
+virtualNetworkType+ + +ApiManagementServiceProperties_VirtualNetworkType + + + |
+
+ VirtualNetworkType: The type of VPN in which API Management service needs to be configured in. None (Default Value) +means the API Management service is not part of any Virtual Network, External means the API Management deployment is set +up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is +setup inside a Virtual Network having an Intranet Facing Endpoint only. + |
+
+zones+ +[]string + + |
+
+ Zones: A list of availability zones denoting where the resource needs to come from. + |
+
| Field | +Description | +
|---|---|
+identity+ + +ApiManagementServiceIdentity_ARM + + + |
+
+ Identity: Managed service identity of the Api Management service. + |
+
+location+ +string + + |
+
+ Location: Resource location. + |
+
+name+ +string + + |
++ | +
+properties+ + +ApiManagementServiceProperties_ARM + + + |
+
+ Properties: Properties of the API Management service. + |
+
+sku+ + +ApiManagementServiceSkuProperties_ARM + + + |
+
+ Sku: SKU properties of the API Management service. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+zones+ +[]string + + |
+
+ Zones: A list of availability zones denoting where the resource needs to come from. + |
+
string alias)+(Appears on:SystemData_STATUS, SystemData_STATUS_ARM) +
+| Value | +Description | +
|---|---|
"Application" |
++ |
"Key" |
++ |
"ManagedIdentity" |
++ |
"User" |
++ |
string alias)+(Appears on:SystemData_STATUS, SystemData_STATUS_ARM) +
+| Value | +Description | +
|---|---|
"Application" |
++ |
"Key" |
++ |
"ManagedIdentity" |
++ |
"User" |
++ |
+(Appears on:Service_STATUS) +
+Metadata pertaining to creation and last modification of the resource.
+| Field | +Description | +
|---|---|
+createdAt+ +string + + |
+
+ CreatedAt: The timestamp of resource creation (UTC). + |
+
+createdBy+ +string + + |
+
+ CreatedBy: The identity that created the resource. + |
+
+createdByType+ + +SystemData_CreatedByType_STATUS + + + |
+
+ CreatedByType: The type of identity that created the resource. + |
+
+lastModifiedAt+ +string + + |
+
+ LastModifiedAt: The timestamp of resource last modification (UTC) + |
+
+lastModifiedBy+ +string + + |
+
+ LastModifiedBy: The identity that last modified the resource. + |
+
+lastModifiedByType+ + +SystemData_LastModifiedByType_STATUS + + + |
+
+ LastModifiedByType: The type of identity that last modified the resource. + |
+
+(Appears on:Service_STATUS_ARM) +
+Metadata pertaining to creation and last modification of the resource.
+| Field | +Description | +
|---|---|
+createdAt+ +string + + |
+
+ CreatedAt: The timestamp of resource creation (UTC). + |
+
+createdBy+ +string + + |
+
+ CreatedBy: The identity that created the resource. + |
+
+createdByType+ + +SystemData_CreatedByType_STATUS + + + |
+
+ CreatedByType: The type of identity that created the resource. + |
+
+lastModifiedAt+ +string + + |
+
+ LastModifiedAt: The timestamp of resource last modification (UTC) + |
+
+lastModifiedBy+ +string + + |
+
+ LastModifiedBy: The identity that last modified the resource. + |
+
+lastModifiedByType+ + +SystemData_LastModifiedByType_STATUS + + + |
+
+ LastModifiedByType: The type of identity that last modified the resource. + |
+
+(Appears on:ApiManagementServiceIdentity) +
+Information about the user assigned identity for the resource
+| Field | +Description | +
|---|---|
+reference+ + +genruntime.ResourceReference + + + |
++ | +
+(Appears on:ApiManagementServiceIdentity_ARM) +
+Information about the user assigned identity for the resource
++(Appears on:ApiManagementServiceIdentity_STATUS) +
+| Field | +Description | +
|---|---|
+clientId+ +string + + |
+
+ ClientId: The client id of user assigned identity. + |
+
+principalId+ +string + + |
+
+ PrincipalId: The principal id of user assigned identity. + |
+
+(Appears on:ApiManagementServiceIdentity_STATUS_ARM) +
+| Field | +Description | +
|---|---|
+clientId+ +string + + |
+
+ ClientId: The client id of user assigned identity. + |
+
+principalId+ +string + + |
+
+ PrincipalId: The principal id of user assigned identity. + |
+
+(Appears on:AdditionalLocation, Service_Spec) +
+Configuration of a virtual network to which API Management service is deployed.
+| Field | +Description | +
|---|---|
+subnetResourceReference+ + +genruntime.ResourceReference + + + |
+
+ SubnetResourceReference: The full resource ID of a subnet in a virtual network to deploy the API Management service in. + |
+
+(Appears on:AdditionalLocation_ARM, ApiManagementServiceProperties_ARM) +
+Configuration of a virtual network to which API Management service is deployed.
+| Field | +Description | +
|---|---|
+subnetResourceId+ +string + + |
++ | +
+(Appears on:AdditionalLocation_STATUS, Service_STATUS) +
+Configuration of a virtual network to which API Management service is deployed.
+| Field | +Description | +
|---|---|
+subnetResourceId+ +string + + |
+
+ SubnetResourceId: The full resource ID of a subnet in a virtual network to deploy the API Management service in. + |
+
+subnetname+ +string + + |
+
+ Subnetname: The name of the subnet. + |
+
+vnetid+ +string + + |
+
+ Vnetid: The virtual network ID. This is typically a GUID. Expect a null GUID by default. + |
+
+(Appears on:AdditionalLocation_STATUS_ARM, ApiManagementServiceProperties_STATUS_ARM) +
+Configuration of a virtual network to which API Management service is deployed.
+| Field | +Description | +
|---|---|
+subnetResourceId+ +string + + |
+
+ SubnetResourceId: The full resource ID of a subnet in a virtual network to deploy the API Management service in. + |
+
+subnetname+ +string + + |
+
+ Subnetname: The name of the subnet. + |
+
+vnetid+ +string + + |
+
+ Vnetid: The virtual network ID. This is typically a GUID. Expect a null GUID by default. + |
+
Package v1api20220401 contains API Schema definitions for the network v1api20220401 API group
+string alias)| Value | +Description | +
|---|---|
"2022-04-01" |
++ |
string alias)+(Appears on:ProfileProperties_ARM, Trafficmanagerprofile_Spec) +
+The allowed type DNS record types for this profile.
+| Value | +Description | +
|---|---|
"Any" |
++ |
"DomainName" |
++ |
"IPv4Address" |
++ |
"IPv6Address" |
++ |
string alias)+(Appears on:ProfileProperties_STATUS_ARM, Trafficmanagerprofile_STATUS) +
+The allowed type DNS record types for this profile.
+| Value | +Description | +
|---|---|
"Any" |
++ |
"DomainName" |
++ |
"IPv4Address" |
++ |
"IPv6Address" |
++ |
+(Appears on:Trafficmanagerprofile_Spec) +
+Class containing DNS settings in a Traffic Manager profile.
+| Field | +Description | +
|---|---|
+relativeName+ +string + + |
+
+ RelativeName: The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain +name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile. + |
+
+ttl+ +int + + |
+
+ Ttl: The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS +responses provided by this Traffic Manager profile. + |
+
+(Appears on:ProfileProperties_ARM) +
+Class containing DNS settings in a Traffic Manager profile.
+| Field | +Description | +
|---|---|
+relativeName+ +string + + |
+
+ RelativeName: The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain +name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile. + |
+
+ttl+ +int + + |
+
+ Ttl: The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS +responses provided by this Traffic Manager profile. + |
+
+(Appears on:Trafficmanagerprofile_STATUS) +
+Class containing DNS settings in a Traffic Manager profile.
+| Field | +Description | +
|---|---|
+fqdn+ +string + + |
+
+ Fqdn: The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of +the RelativeName with the DNS domain used by Azure Traffic Manager. + |
+
+relativeName+ +string + + |
+
+ RelativeName: The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain +name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile. + |
+
+ttl+ +int + + |
+
+ Ttl: The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS +responses provided by this Traffic Manager profile. + |
+
+(Appears on:ProfileProperties_STATUS_ARM) +
+Class containing DNS settings in a Traffic Manager profile.
+| Field | +Description | +
|---|---|
+fqdn+ +string + + |
+
+ Fqdn: The fully-qualified domain name (FQDN) of the Traffic Manager profile. This is formed from the concatenation of +the RelativeName with the DNS domain used by Azure Traffic Manager. + |
+
+relativeName+ +string + + |
+
+ RelativeName: The relative DNS name provided by this Traffic Manager profile. This value is combined with the DNS domain +name used by Azure Traffic Manager to form the fully-qualified domain name (FQDN) of the profile. + |
+
+ttl+ +int + + |
+
+ Ttl: The DNS Time-To-Live (TTL), in seconds. This informs the local DNS resolvers and DNS clients how long to cache DNS +responses provided by this Traffic Manager profile. + |
+
+(Appears on:Trafficmanagerprofiles_AzureEndpoint_Spec_ARM, Trafficmanagerprofiles_ExternalEndpoint_Spec_ARM, Trafficmanagerprofiles_NestedEndpoint_Spec_ARM) +
+Class representing a Traffic Manager endpoint properties.
+| Field | +Description | +
|---|---|
+alwaysServe+ + +EndpointProperties_AlwaysServe + + + |
+
+ AlwaysServe: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in +the traffic routing method. + |
+
+customHeaders+ + +[]EndpointProperties_CustomHeaders_ARM + + + |
+
+ CustomHeaders: List of custom headers. + |
+
+endpointLocation+ +string + + |
+
+ EndpointLocation: Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic +routing method. + |
+
+endpointMonitorStatus+ + +EndpointProperties_EndpointMonitorStatus + + + |
+
+ EndpointMonitorStatus: The monitoring status of the endpoint. + |
+
+endpointStatus+ + +EndpointProperties_EndpointStatus + + + |
+
+ EndpointStatus: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included +in the traffic routing method. + |
+
+geoMapping+ +[]string + + |
+
+ GeoMapping: The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. +Please consult Traffic Manager Geographic documentation for a full list of accepted values. + |
+
+minChildEndpoints+ +int + + |
+
+ MinChildEndpoints: The minimum number of endpoints that must be available in the child profile in order for the parent +profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. + |
+
+minChildEndpointsIPv4+ +int + + |
+
+ MinChildEndpointsIPv4: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child +profile in order for the parent profile to be considered available. Only applicable to endpoint of type +‘NestedEndpoints’. + |
+
+minChildEndpointsIPv6+ +int + + |
+
+ MinChildEndpointsIPv6: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child +profile in order for the parent profile to be considered available. Only applicable to endpoint of type +‘NestedEndpoints’. + |
+
+priority+ +int + + |
+
+ Priority: The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to +1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all +endpoints, and no two endpoints can share the same priority value. + |
+
+subnets+ + +[]EndpointProperties_Subnets_ARM + + + |
+
+ Subnets: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the ‘Subnet’ +traffic routing method. An empty list will match all ranges not covered by other endpoints. + |
+
+target+ +string + + |
+
+ Target: The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses +to direct traffic to this endpoint. + |
+
+targetResourceId+ +string + + |
++ | +
+weight+ +int + + |
+
+ Weight: The weight of this endpoint when using the ‘Weighted’ traffic routing method. Possible values are from 1 to 1000. + |
+
string alias)+(Appears on:EndpointProperties_ARM, Trafficmanagerprofiles_AzureEndpoint_Spec, Trafficmanagerprofiles_ExternalEndpoint_Spec, Trafficmanagerprofiles_NestedEndpoint_Spec) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
string alias)+(Appears on:EndpointProperties_STATUS_ARM, Trafficmanagerprofiles_AzureEndpoint_STATUS, Trafficmanagerprofiles_ExternalEndpoint_STATUS, Trafficmanagerprofiles_NestedEndpoint_STATUS) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
+(Appears on:Trafficmanagerprofiles_AzureEndpoint_Spec, Trafficmanagerprofiles_ExternalEndpoint_Spec, Trafficmanagerprofiles_NestedEndpoint_Spec) +
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: Header name. + |
+
+value+ +string + + |
+
+ Value: Header value. + |
+
+(Appears on:EndpointProperties_ARM) +
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: Header name. + |
+
+value+ +string + + |
+
+ Value: Header value. + |
+
+(Appears on:Trafficmanagerprofiles_AzureEndpoint_STATUS, Trafficmanagerprofiles_ExternalEndpoint_STATUS, Trafficmanagerprofiles_NestedEndpoint_STATUS) +
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: Header name. + |
+
+value+ +string + + |
+
+ Value: Header value. + |
+
+(Appears on:EndpointProperties_STATUS_ARM) +
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: Header name. + |
+
+value+ +string + + |
+
+ Value: Header value. + |
+
string alias)+(Appears on:EndpointProperties_ARM, Trafficmanagerprofiles_AzureEndpoint_Spec, Trafficmanagerprofiles_ExternalEndpoint_Spec, Trafficmanagerprofiles_NestedEndpoint_Spec) +
+| Value | +Description | +
|---|---|
"CheckingEndpoint" |
++ |
"Degraded" |
++ |
"Disabled" |
++ |
"Inactive" |
++ |
"Online" |
++ |
"Stopped" |
++ |
"Unmonitored" |
++ |
string alias)+(Appears on:EndpointProperties_STATUS_ARM, Trafficmanagerprofiles_AzureEndpoint_STATUS, Trafficmanagerprofiles_ExternalEndpoint_STATUS, Trafficmanagerprofiles_NestedEndpoint_STATUS) +
+| Value | +Description | +
|---|---|
"CheckingEndpoint" |
++ |
"Degraded" |
++ |
"Disabled" |
++ |
"Inactive" |
++ |
"Online" |
++ |
"Stopped" |
++ |
"Unmonitored" |
++ |
string alias)+(Appears on:EndpointProperties_ARM, Trafficmanagerprofiles_AzureEndpoint_Spec, Trafficmanagerprofiles_ExternalEndpoint_Spec, Trafficmanagerprofiles_NestedEndpoint_Spec) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
string alias)+(Appears on:EndpointProperties_STATUS_ARM, Trafficmanagerprofiles_AzureEndpoint_STATUS, Trafficmanagerprofiles_ExternalEndpoint_STATUS, Trafficmanagerprofiles_NestedEndpoint_STATUS) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
+(Appears on:Trafficmanagerprofiles_AzureEndpoint_STATUS_ARM, Trafficmanagerprofiles_ExternalEndpoint_STATUS_ARM, Trafficmanagerprofiles_NestedEndpoint_STATUS_ARM) +
+Class representing a Traffic Manager endpoint properties.
+| Field | +Description | +
|---|---|
+alwaysServe+ + +EndpointProperties_AlwaysServe_STATUS + + + |
+
+ AlwaysServe: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in +the traffic routing method. + |
+
+customHeaders+ + +[]EndpointProperties_CustomHeaders_STATUS_ARM + + + |
+
+ CustomHeaders: List of custom headers. + |
+
+endpointLocation+ +string + + |
+
+ EndpointLocation: Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic +routing method. + |
+
+endpointMonitorStatus+ + +EndpointProperties_EndpointMonitorStatus_STATUS + + + |
+
+ EndpointMonitorStatus: The monitoring status of the endpoint. + |
+
+endpointStatus+ + +EndpointProperties_EndpointStatus_STATUS + + + |
+
+ EndpointStatus: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included +in the traffic routing method. + |
+
+geoMapping+ +[]string + + |
+
+ GeoMapping: The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. +Please consult Traffic Manager Geographic documentation for a full list of accepted values. + |
+
+minChildEndpoints+ +int + + |
+
+ MinChildEndpoints: The minimum number of endpoints that must be available in the child profile in order for the parent +profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. + |
+
+minChildEndpointsIPv4+ +int + + |
+
+ MinChildEndpointsIPv4: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child +profile in order for the parent profile to be considered available. Only applicable to endpoint of type +‘NestedEndpoints’. + |
+
+minChildEndpointsIPv6+ +int + + |
+
+ MinChildEndpointsIPv6: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child +profile in order for the parent profile to be considered available. Only applicable to endpoint of type +‘NestedEndpoints’. + |
+
+priority+ +int + + |
+
+ Priority: The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to +1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all +endpoints, and no two endpoints can share the same priority value. + |
+
+subnets+ + +[]EndpointProperties_Subnets_STATUS_ARM + + + |
+
+ Subnets: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the ‘Subnet’ +traffic routing method. An empty list will match all ranges not covered by other endpoints. + |
+
+target+ +string + + |
+
+ Target: The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses +to direct traffic to this endpoint. + |
+
+targetResourceId+ +string + + |
+
+ TargetResourceId: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type ‘ExternalEndpoints’. + |
+
+weight+ +int + + |
+
+ Weight: The weight of this endpoint when using the ‘Weighted’ traffic routing method. Possible values are from 1 to 1000. + |
+
+(Appears on:Trafficmanagerprofiles_AzureEndpoint_Spec, Trafficmanagerprofiles_ExternalEndpoint_Spec, Trafficmanagerprofiles_NestedEndpoint_Spec) +
+| Field | +Description | +
|---|---|
+first+ +string + + |
+
+ First: First address in the subnet. + |
+
+last+ +string + + |
+
+ Last: Last address in the subnet. + |
+
+scope+ +int + + |
+
+ Scope: Block size (number of leading bits in the subnet mask). + |
+
+(Appears on:EndpointProperties_ARM) +
+| Field | +Description | +
|---|---|
+first+ +string + + |
+
+ First: First address in the subnet. + |
+
+last+ +string + + |
+
+ Last: Last address in the subnet. + |
+
+scope+ +int + + |
+
+ Scope: Block size (number of leading bits in the subnet mask). + |
+
+(Appears on:Trafficmanagerprofiles_AzureEndpoint_STATUS, Trafficmanagerprofiles_ExternalEndpoint_STATUS, Trafficmanagerprofiles_NestedEndpoint_STATUS) +
+| Field | +Description | +
|---|---|
+first+ +string + + |
+
+ First: First address in the subnet. + |
+
+last+ +string + + |
+
+ Last: Last address in the subnet. + |
+
+scope+ +int + + |
+
+ Scope: Block size (number of leading bits in the subnet mask). + |
+
+(Appears on:EndpointProperties_STATUS_ARM) +
+| Field | +Description | +
|---|---|
+first+ +string + + |
+
+ First: First address in the subnet. + |
+
+last+ +string + + |
+
+ Last: Last address in the subnet. + |
+
+scope+ +int + + |
+
+ Scope: Block size (number of leading bits in the subnet mask). + |
+
+(Appears on:Trafficmanagerprofile_STATUS) +
+Class representing a Traffic Manager endpoint.
+| Field | +Description | +
|---|---|
+id+ +string + + |
+
+ Id: Fully qualified resource Id for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} + |
+
+(Appears on:ProfileProperties_STATUS_ARM) +
+Class representing a Traffic Manager endpoint.
+| Field | +Description | +
|---|---|
+id+ +string + + |
+
+ Id: Fully qualified resource Id for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} + |
+
+(Appears on:Trafficmanagerprofile_Spec) +
+Class containing endpoint monitoring settings in a Traffic Manager profile.
+| Field | +Description | +
|---|---|
+customHeaders+ + +[]MonitorConfig_CustomHeaders + + + |
+
+ CustomHeaders: List of custom headers. + |
+
+expectedStatusCodeRanges+ + +[]MonitorConfig_ExpectedStatusCodeRanges + + + |
+
+ ExpectedStatusCodeRanges: List of expected status code ranges. + |
+
+intervalInSeconds+ +int + + |
+
+ IntervalInSeconds: The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager +will check the health of each endpoint in this profile. + |
+
+path+ +string + + |
+
+ Path: The path relative to the endpoint domain name used to probe for endpoint health. + |
+
+port+ +int + + |
+
+ Port: The TCP port used to probe for endpoint health. + |
+
+profileMonitorStatus+ + +MonitorConfig_ProfileMonitorStatus + + + |
+
+ ProfileMonitorStatus: The profile-level monitoring status of the Traffic Manager profile. + |
+
+protocol+ + +MonitorConfig_Protocol + + + |
+
+ Protocol: The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. + |
+
+timeoutInSeconds+ +int + + |
+
+ TimeoutInSeconds: The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows +endpoints in this profile to response to the health check. + |
+
+toleratedNumberOfFailures+ +int + + |
+
+ ToleratedNumberOfFailures: The number of consecutive failed health check that Traffic Manager tolerates before declaring +an endpoint in this profile Degraded after the next failed health check. + |
+
+(Appears on:ProfileProperties_ARM) +
+Class containing endpoint monitoring settings in a Traffic Manager profile.
+| Field | +Description | +
|---|---|
+customHeaders+ + +[]MonitorConfig_CustomHeaders_ARM + + + |
+
+ CustomHeaders: List of custom headers. + |
+
+expectedStatusCodeRanges+ + +[]MonitorConfig_ExpectedStatusCodeRanges_ARM + + + |
+
+ ExpectedStatusCodeRanges: List of expected status code ranges. + |
+
+intervalInSeconds+ +int + + |
+
+ IntervalInSeconds: The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager +will check the health of each endpoint in this profile. + |
+
+path+ +string + + |
+
+ Path: The path relative to the endpoint domain name used to probe for endpoint health. + |
+
+port+ +int + + |
+
+ Port: The TCP port used to probe for endpoint health. + |
+
+profileMonitorStatus+ + +MonitorConfig_ProfileMonitorStatus + + + |
+
+ ProfileMonitorStatus: The profile-level monitoring status of the Traffic Manager profile. + |
+
+protocol+ + +MonitorConfig_Protocol + + + |
+
+ Protocol: The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. + |
+
+timeoutInSeconds+ +int + + |
+
+ TimeoutInSeconds: The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows +endpoints in this profile to response to the health check. + |
+
+toleratedNumberOfFailures+ +int + + |
+
+ ToleratedNumberOfFailures: The number of consecutive failed health check that Traffic Manager tolerates before declaring +an endpoint in this profile Degraded after the next failed health check. + |
+
+(Appears on:MonitorConfig) +
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: Header name. + |
+
+value+ +string + + |
+
+ Value: Header value. + |
+
+(Appears on:MonitorConfig_ARM) +
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: Header name. + |
+
+value+ +string + + |
+
+ Value: Header value. + |
+
+(Appears on:MonitorConfig_STATUS) +
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: Header name. + |
+
+value+ +string + + |
+
+ Value: Header value. + |
+
+(Appears on:MonitorConfig_STATUS_ARM) +
+| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: Header name. + |
+
+value+ +string + + |
+
+ Value: Header value. + |
+
+(Appears on:MonitorConfig) +
+| Field | +Description | +
|---|---|
+max+ +int + + |
+
+ Max: Max status code. + |
+
+min+ +int + + |
+
+ Min: Min status code. + |
+
+(Appears on:MonitorConfig_ARM) +
+| Field | +Description | +
|---|---|
+max+ +int + + |
+
+ Max: Max status code. + |
+
+min+ +int + + |
+
+ Min: Min status code. + |
+
+(Appears on:MonitorConfig_STATUS) +
+| Field | +Description | +
|---|---|
+max+ +int + + |
+
+ Max: Max status code. + |
+
+min+ +int + + |
+
+ Min: Min status code. + |
+
+(Appears on:MonitorConfig_STATUS_ARM) +
+| Field | +Description | +
|---|---|
+max+ +int + + |
+
+ Max: Max status code. + |
+
+min+ +int + + |
+
+ Min: Min status code. + |
+
string alias)+(Appears on:MonitorConfig, MonitorConfig_ARM) +
+| Value | +Description | +
|---|---|
"CheckingEndpoints" |
++ |
"Degraded" |
++ |
"Disabled" |
++ |
"Inactive" |
++ |
"Online" |
++ |
string alias)+(Appears on:MonitorConfig_STATUS, MonitorConfig_STATUS_ARM) +
+| Value | +Description | +
|---|---|
"CheckingEndpoints" |
++ |
"Degraded" |
++ |
"Disabled" |
++ |
"Inactive" |
++ |
"Online" |
++ |
string alias)+(Appears on:MonitorConfig, MonitorConfig_ARM) +
+| Value | +Description | +
|---|---|
"HTTP" |
++ |
"HTTPS" |
++ |
"TCP" |
++ |
string alias)+(Appears on:MonitorConfig_STATUS, MonitorConfig_STATUS_ARM) +
+| Value | +Description | +
|---|---|
"HTTP" |
++ |
"HTTPS" |
++ |
"TCP" |
++ |
+(Appears on:Trafficmanagerprofile_STATUS) +
+Class containing endpoint monitoring settings in a Traffic Manager profile.
+| Field | +Description | +
|---|---|
+customHeaders+ + +[]MonitorConfig_CustomHeaders_STATUS + + + |
+
+ CustomHeaders: List of custom headers. + |
+
+expectedStatusCodeRanges+ + +[]MonitorConfig_ExpectedStatusCodeRanges_STATUS + + + |
+
+ ExpectedStatusCodeRanges: List of expected status code ranges. + |
+
+intervalInSeconds+ +int + + |
+
+ IntervalInSeconds: The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager +will check the health of each endpoint in this profile. + |
+
+path+ +string + + |
+
+ Path: The path relative to the endpoint domain name used to probe for endpoint health. + |
+
+port+ +int + + |
+
+ Port: The TCP port used to probe for endpoint health. + |
+
+profileMonitorStatus+ + +MonitorConfig_ProfileMonitorStatus_STATUS + + + |
+
+ ProfileMonitorStatus: The profile-level monitoring status of the Traffic Manager profile. + |
+
+protocol+ + +MonitorConfig_Protocol_STATUS + + + |
+
+ Protocol: The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. + |
+
+timeoutInSeconds+ +int + + |
+
+ TimeoutInSeconds: The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows +endpoints in this profile to response to the health check. + |
+
+toleratedNumberOfFailures+ +int + + |
+
+ ToleratedNumberOfFailures: The number of consecutive failed health check that Traffic Manager tolerates before declaring +an endpoint in this profile Degraded after the next failed health check. + |
+
+(Appears on:ProfileProperties_STATUS_ARM) +
+Class containing endpoint monitoring settings in a Traffic Manager profile.
+| Field | +Description | +
|---|---|
+customHeaders+ + +[]MonitorConfig_CustomHeaders_STATUS_ARM + + + |
+
+ CustomHeaders: List of custom headers. + |
+
+expectedStatusCodeRanges+ + +[]MonitorConfig_ExpectedStatusCodeRanges_STATUS_ARM + + + |
+
+ ExpectedStatusCodeRanges: List of expected status code ranges. + |
+
+intervalInSeconds+ +int + + |
+
+ IntervalInSeconds: The monitor interval for endpoints in this profile. This is the interval at which Traffic Manager +will check the health of each endpoint in this profile. + |
+
+path+ +string + + |
+
+ Path: The path relative to the endpoint domain name used to probe for endpoint health. + |
+
+port+ +int + + |
+
+ Port: The TCP port used to probe for endpoint health. + |
+
+profileMonitorStatus+ + +MonitorConfig_ProfileMonitorStatus_STATUS + + + |
+
+ ProfileMonitorStatus: The profile-level monitoring status of the Traffic Manager profile. + |
+
+protocol+ + +MonitorConfig_Protocol_STATUS + + + |
+
+ Protocol: The protocol (HTTP, HTTPS or TCP) used to probe for endpoint health. + |
+
+timeoutInSeconds+ +int + + |
+
+ TimeoutInSeconds: The monitor timeout for endpoints in this profile. This is the time that Traffic Manager allows +endpoints in this profile to response to the health check. + |
+
+toleratedNumberOfFailures+ +int + + |
+
+ ToleratedNumberOfFailures: The number of consecutive failed health check that Traffic Manager tolerates before declaring +an endpoint in this profile Degraded after the next failed health check. + |
+
+(Appears on:Trafficmanagerprofile_Spec_ARM) +
+Class representing the Traffic Manager profile properties.
+| Field | +Description | +
|---|---|
+allowedEndpointRecordTypes+ + +[]AllowedEndpointRecordType + + + |
+
+ AllowedEndpointRecordTypes: The list of allowed endpoint record types. + |
+
+dnsConfig+ + +DnsConfig_ARM + + + |
+
+ DnsConfig: The DNS settings of the Traffic Manager profile. + |
+
+maxReturn+ +int + + |
+
+ MaxReturn: Maximum number of endpoints to be returned for MultiValue routing type. + |
+
+monitorConfig+ + +MonitorConfig_ARM + + + |
+
+ MonitorConfig: The endpoint monitoring settings of the Traffic Manager profile. + |
+
+profileStatus+ + +ProfileProperties_ProfileStatus + + + |
+
+ ProfileStatus: The status of the Traffic Manager profile. + |
+
+trafficRoutingMethod+ + +ProfileProperties_TrafficRoutingMethod + + + |
+
+ TrafficRoutingMethod: The traffic routing method of the Traffic Manager profile. + |
+
+trafficViewEnrollmentStatus+ + +ProfileProperties_TrafficViewEnrollmentStatus + + + |
+
+ TrafficViewEnrollmentStatus: Indicates whether Traffic View is ‘Enabled’ or ‘Disabled’ for the Traffic Manager profile. +Null, indicates ‘Disabled’. Enabling this feature will increase the cost of the Traffic Manage profile. + |
+
string alias)+(Appears on:ProfileProperties_ARM, Trafficmanagerprofile_Spec) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
string alias)+(Appears on:ProfileProperties_STATUS_ARM, Trafficmanagerprofile_STATUS) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
+(Appears on:Trafficmanagerprofile_STATUS_ARM) +
+Class representing the Traffic Manager profile properties.
+| Field | +Description | +
|---|---|
+allowedEndpointRecordTypes+ + +[]AllowedEndpointRecordType_STATUS + + + |
+
+ AllowedEndpointRecordTypes: The list of allowed endpoint record types. + |
+
+dnsConfig+ + +DnsConfig_STATUS_ARM + + + |
+
+ DnsConfig: The DNS settings of the Traffic Manager profile. + |
+
+endpoints+ + +[]Endpoint_STATUS_ARM + + + |
+
+ Endpoints: The list of endpoints in the Traffic Manager profile. + |
+
+maxReturn+ +int + + |
+
+ MaxReturn: Maximum number of endpoints to be returned for MultiValue routing type. + |
+
+monitorConfig+ + +MonitorConfig_STATUS_ARM + + + |
+
+ MonitorConfig: The endpoint monitoring settings of the Traffic Manager profile. + |
+
+profileStatus+ + +ProfileProperties_ProfileStatus_STATUS + + + |
+
+ ProfileStatus: The status of the Traffic Manager profile. + |
+
+trafficRoutingMethod+ + +ProfileProperties_TrafficRoutingMethod_STATUS + + + |
+
+ TrafficRoutingMethod: The traffic routing method of the Traffic Manager profile. + |
+
+trafficViewEnrollmentStatus+ + +ProfileProperties_TrafficViewEnrollmentStatus_STATUS + + + |
+
+ TrafficViewEnrollmentStatus: Indicates whether Traffic View is ‘Enabled’ or ‘Disabled’ for the Traffic Manager profile. +Null, indicates ‘Disabled’. Enabling this feature will increase the cost of the Traffic Manage profile. + |
+
string alias)+(Appears on:ProfileProperties_ARM, Trafficmanagerprofile_Spec) +
+| Value | +Description | +
|---|---|
"Geographic" |
++ |
"MultiValue" |
++ |
"Performance" |
++ |
"Priority" |
++ |
"Subnet" |
++ |
"Weighted" |
++ |
string alias)+(Appears on:ProfileProperties_STATUS_ARM, Trafficmanagerprofile_STATUS) +
+| Value | +Description | +
|---|---|
"Geographic" |
++ |
"MultiValue" |
++ |
"Performance" |
++ |
"Priority" |
++ |
"Subnet" |
++ |
"Weighted" |
++ |
string alias)+(Appears on:ProfileProperties_ARM, Trafficmanagerprofile_Spec) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
string alias)+(Appears on:ProfileProperties_STATUS_ARM, Trafficmanagerprofile_STATUS) +
+| Value | +Description | +
|---|---|
"Disabled" |
++ |
"Enabled" |
++ |
Generator information: +- Generated from: /trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/trafficmanager.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName} +
| Field | +Description | +||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||||||||
+spec+ + +Trafficmanagerprofile_Spec + + + |
+
+ + +
|
+||||||||||||||||||||||||||
+status+ + +Trafficmanagerprofile_STATUS + + + |
++ | +
+(Appears on:TrafficManagerProfileOperatorSpec) +
+| Field | +Description | +
|---|---|
+dnsConfigFqdn+ + +genruntime.ConfigMapDestination + + + |
+
+ DnsConfigFqdn: indicates where the DnsConfigFqdn config map should be placed. If omitted, no config map will be created. + |
+
+(Appears on:Trafficmanagerprofile_Spec) +
+Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure
+| Field | +Description | +
|---|---|
+configMaps+ + +TrafficManagerProfileOperatorConfigMaps + + + |
+
+ ConfigMaps: configures where to place operator written ConfigMaps. + |
+
Generator information: +- Generated from: /trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/trafficmanager.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/AzureEndpoints/{endpointName} +
| Field | +Description | +||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||||||||||||||||
+spec+ + +Trafficmanagerprofiles_AzureEndpoint_Spec + + + |
+
+ + +
|
+||||||||||||||||||||||||||||||||||
+status+ + +Trafficmanagerprofiles_AzureEndpoint_STATUS + + + |
++ | +
Generator information: +- Generated from: /trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/trafficmanager.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/ExternalEndpoints/{endpointName} +
| Field | +Description | +||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||||||||||||||||
+spec+ + +Trafficmanagerprofiles_ExternalEndpoint_Spec + + + |
+
+ + +
|
+||||||||||||||||||||||||||||||||||
+status+ + +Trafficmanagerprofiles_ExternalEndpoint_STATUS + + + |
++ | +
Generator information: +- Generated from: /trafficmanager/resource-manager/Microsoft.Network/stable/2022-04-01/trafficmanager.json +- ARM URI: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficmanagerprofiles/{profileName}/NestedEndpoints/{endpointName} +
| Field | +Description | +||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
+metadata+ + +Kubernetes meta/v1.ObjectMeta + + + |
+
+Refer to the Kubernetes API documentation for the fields of the
+metadata field.
+ |
+||||||||||||||||||||||||||||||||||
+spec+ + +Trafficmanagerprofiles_NestedEndpoint_Spec + + + |
+
+ + +
|
+||||||||||||||||||||||||||||||||||
+status+ + +Trafficmanagerprofiles_NestedEndpoint_STATUS + + + |
++ | +
+(Appears on:TrafficManagerProfile) +
+| Field | +Description | +
|---|---|
+allowedEndpointRecordTypes+ + +[]AllowedEndpointRecordType_STATUS + + + |
+
+ AllowedEndpointRecordTypes: The list of allowed endpoint record types. + |
+
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+dnsConfig+ + +DnsConfig_STATUS + + + |
+
+ DnsConfig: The DNS settings of the Traffic Manager profile. + |
+
+endpoints+ + +[]Endpoint_STATUS + + + |
+
+ Endpoints: The list of endpoints in the Traffic Manager profile. + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource Id for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} + |
+
+location+ +string + + |
+
+ Location: The Azure Region where the resource lives + |
+
+maxReturn+ +int + + |
+
+ MaxReturn: Maximum number of endpoints to be returned for MultiValue routing type. + |
+
+monitorConfig+ + +MonitorConfig_STATUS + + + |
+
+ MonitorConfig: The endpoint monitoring settings of the Traffic Manager profile. + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+profileStatus+ + +ProfileProperties_ProfileStatus_STATUS + + + |
+
+ ProfileStatus: The status of the Traffic Manager profile. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+trafficRoutingMethod+ + +ProfileProperties_TrafficRoutingMethod_STATUS + + + |
+
+ TrafficRoutingMethod: The traffic routing method of the Traffic Manager profile. + |
+
+trafficViewEnrollmentStatus+ + +ProfileProperties_TrafficViewEnrollmentStatus_STATUS + + + |
+
+ TrafficViewEnrollmentStatus: Indicates whether Traffic View is ‘Enabled’ or ‘Disabled’ for the Traffic Manager profile. +Null, indicates ‘Disabled’. Enabling this feature will increase the cost of the Traffic Manage profile. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. + |
+
| Field | +Description | +
|---|---|
+id+ +string + + |
+
+ Id: Fully qualified resource Id for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} + |
+
+location+ +string + + |
+
+ Location: The Azure Region where the resource lives + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+properties+ + +ProfileProperties_STATUS_ARM + + + |
+
+ Properties: The properties of the Traffic Manager profile. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. + |
+
+(Appears on:TrafficManagerProfile) +
+| Field | +Description | +
|---|---|
+allowedEndpointRecordTypes+ + +[]AllowedEndpointRecordType + + + |
+
+ AllowedEndpointRecordTypes: The list of allowed endpoint record types. + |
+
+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. + |
+
+dnsConfig+ + +DnsConfig + + + |
+
+ DnsConfig: The DNS settings of the Traffic Manager profile. + |
+
+location+ +string + + |
+
+ Location: The Azure Region where the resource lives + |
+
+maxReturn+ +int + + |
+
+ MaxReturn: Maximum number of endpoints to be returned for MultiValue routing type. + |
+
+monitorConfig+ + +MonitorConfig + + + |
+
+ MonitorConfig: The endpoint monitoring settings of the Traffic Manager profile. + |
+
+operatorSpec+ + +TrafficManagerProfileOperatorSpec + + + |
+
+ 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 + |
+
+profileStatus+ + +ProfileProperties_ProfileStatus + + + |
+
+ ProfileStatus: The status of the Traffic Manager profile. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+trafficRoutingMethod+ + +ProfileProperties_TrafficRoutingMethod + + + |
+
+ TrafficRoutingMethod: The traffic routing method of the Traffic Manager profile. + |
+
+trafficViewEnrollmentStatus+ + +ProfileProperties_TrafficViewEnrollmentStatus + + + |
+
+ TrafficViewEnrollmentStatus: Indicates whether Traffic View is ‘Enabled’ or ‘Disabled’ for the Traffic Manager profile. +Null, indicates ‘Disabled’. Enabling this feature will increase the cost of the Traffic Manage profile. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. + |
+
| Field | +Description | +
|---|---|
+location+ +string + + |
+
+ Location: The Azure Region where the resource lives + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+properties+ + +ProfileProperties_ARM + + + |
+
+ Properties: The properties of the Traffic Manager profile. + |
+
+tags+ +map[string]string + + |
+
+ Tags: Resource tags. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. + |
+
+(Appears on:TrafficManagerProfilesAzureEndpoint) +
+| Field | +Description | +
|---|---|
+alwaysServe+ + +EndpointProperties_AlwaysServe_STATUS + + + |
+
+ AlwaysServe: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in +the traffic routing method. + |
+
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+customHeaders+ + +[]EndpointProperties_CustomHeaders_STATUS + + + |
+
+ CustomHeaders: List of custom headers. + |
+
+endpointLocation+ +string + + |
+
+ EndpointLocation: Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic +routing method. + |
+
+endpointMonitorStatus+ + +EndpointProperties_EndpointMonitorStatus_STATUS + + + |
+
+ EndpointMonitorStatus: The monitoring status of the endpoint. + |
+
+endpointStatus+ + +EndpointProperties_EndpointStatus_STATUS + + + |
+
+ EndpointStatus: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included +in the traffic routing method. + |
+
+geoMapping+ +[]string + + |
+
+ GeoMapping: The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. +Please consult Traffic Manager Geographic documentation for a full list of accepted values. + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource Id for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} + |
+
+minChildEndpoints+ +int + + |
+
+ MinChildEndpoints: The minimum number of endpoints that must be available in the child profile in order for the parent +profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. + |
+
+minChildEndpointsIPv4+ +int + + |
+
+ MinChildEndpointsIPv4: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child +profile in order for the parent profile to be considered available. Only applicable to endpoint of type +‘NestedEndpoints’. + |
+
+minChildEndpointsIPv6+ +int + + |
+
+ MinChildEndpointsIPv6: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child +profile in order for the parent profile to be considered available. Only applicable to endpoint of type +‘NestedEndpoints’. + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+priority+ +int + + |
+
+ Priority: The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to +1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all +endpoints, and no two endpoints can share the same priority value. + |
+
+subnets+ + +[]EndpointProperties_Subnets_STATUS + + + |
+
+ Subnets: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the ‘Subnet’ +traffic routing method. An empty list will match all ranges not covered by other endpoints. + |
+
+target+ +string + + |
+
+ Target: The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses +to direct traffic to this endpoint. + |
+
+targetResourceId+ +string + + |
+
+ TargetResourceId: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type ‘ExternalEndpoints’. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. + |
+
+weight+ +int + + |
+
+ Weight: The weight of this endpoint when using the ‘Weighted’ traffic routing method. Possible values are from 1 to 1000. + |
+
| Field | +Description | +
|---|---|
+id+ +string + + |
+
+ Id: Fully qualified resource Id for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+properties+ + +EndpointProperties_STATUS_ARM + + + |
+
+ Properties: The properties of the Traffic Manager endpoint. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. + |
+
+(Appears on:TrafficManagerProfilesAzureEndpoint) +
+| Field | +Description | +
|---|---|
+alwaysServe+ + +EndpointProperties_AlwaysServe + + + |
+
+ AlwaysServe: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in +the traffic routing method. + |
+
+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. + |
+
+customHeaders+ + +[]EndpointProperties_CustomHeaders + + + |
+
+ CustomHeaders: List of custom headers. + |
+
+endpointLocation+ +string + + |
+
+ EndpointLocation: Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic +routing method. + |
+
+endpointMonitorStatus+ + +EndpointProperties_EndpointMonitorStatus + + + |
+
+ EndpointMonitorStatus: The monitoring status of the endpoint. + |
+
+endpointStatus+ + +EndpointProperties_EndpointStatus + + + |
+
+ EndpointStatus: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included +in the traffic routing method. + |
+
+geoMapping+ +[]string + + |
+
+ GeoMapping: The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. +Please consult Traffic Manager Geographic documentation for a full list of accepted values. + |
+
+minChildEndpoints+ +int + + |
+
+ MinChildEndpoints: The minimum number of endpoints that must be available in the child profile in order for the parent +profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. + |
+
+minChildEndpointsIPv4+ +int + + |
+
+ MinChildEndpointsIPv4: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child +profile in order for the parent profile to be considered available. Only applicable to endpoint of type +‘NestedEndpoints’. + |
+
+minChildEndpointsIPv6+ +int + + |
+
+ MinChildEndpointsIPv6: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child +profile in order for the parent profile to be considered available. Only applicable to endpoint of type +‘NestedEndpoints’. + |
+
+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 network.azure.com/TrafficManagerProfile resource + |
+
+priority+ +int + + |
+
+ Priority: The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to +1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all +endpoints, and no two endpoints can share the same priority value. + |
+
+subnets+ + +[]EndpointProperties_Subnets + + + |
+
+ Subnets: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the ‘Subnet’ +traffic routing method. An empty list will match all ranges not covered by other endpoints. + |
+
+target+ +string + + |
+
+ Target: The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses +to direct traffic to this endpoint. + |
+
+targetResourceReference+ + +genruntime.ResourceReference + + + |
+
+ TargetResourceReference: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type +‘ExternalEndpoints’. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. + |
+
+weight+ +int + + |
+
+ Weight: The weight of this endpoint when using the ‘Weighted’ traffic routing method. Possible values are from 1 to 1000. + |
+
| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+properties+ + +EndpointProperties_ARM + + + |
+
+ Properties: The properties of the Traffic Manager endpoint. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. + |
+
+(Appears on:TrafficManagerProfilesExternalEndpoint) +
+| Field | +Description | +
|---|---|
+alwaysServe+ + +EndpointProperties_AlwaysServe_STATUS + + + |
+
+ AlwaysServe: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in +the traffic routing method. + |
+
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+customHeaders+ + +[]EndpointProperties_CustomHeaders_STATUS + + + |
+
+ CustomHeaders: List of custom headers. + |
+
+endpointLocation+ +string + + |
+
+ EndpointLocation: Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic +routing method. + |
+
+endpointMonitorStatus+ + +EndpointProperties_EndpointMonitorStatus_STATUS + + + |
+
+ EndpointMonitorStatus: The monitoring status of the endpoint. + |
+
+endpointStatus+ + +EndpointProperties_EndpointStatus_STATUS + + + |
+
+ EndpointStatus: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included +in the traffic routing method. + |
+
+geoMapping+ +[]string + + |
+
+ GeoMapping: The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. +Please consult Traffic Manager Geographic documentation for a full list of accepted values. + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource Id for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} + |
+
+minChildEndpoints+ +int + + |
+
+ MinChildEndpoints: The minimum number of endpoints that must be available in the child profile in order for the parent +profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. + |
+
+minChildEndpointsIPv4+ +int + + |
+
+ MinChildEndpointsIPv4: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child +profile in order for the parent profile to be considered available. Only applicable to endpoint of type +‘NestedEndpoints’. + |
+
+minChildEndpointsIPv6+ +int + + |
+
+ MinChildEndpointsIPv6: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child +profile in order for the parent profile to be considered available. Only applicable to endpoint of type +‘NestedEndpoints’. + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+priority+ +int + + |
+
+ Priority: The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to +1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all +endpoints, and no two endpoints can share the same priority value. + |
+
+subnets+ + +[]EndpointProperties_Subnets_STATUS + + + |
+
+ Subnets: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the ‘Subnet’ +traffic routing method. An empty list will match all ranges not covered by other endpoints. + |
+
+target+ +string + + |
+
+ Target: The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses +to direct traffic to this endpoint. + |
+
+targetResourceId+ +string + + |
+
+ TargetResourceId: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type ‘ExternalEndpoints’. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. + |
+
+weight+ +int + + |
+
+ Weight: The weight of this endpoint when using the ‘Weighted’ traffic routing method. Possible values are from 1 to 1000. + |
+
| Field | +Description | +
|---|---|
+id+ +string + + |
+
+ Id: Fully qualified resource Id for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+properties+ + +EndpointProperties_STATUS_ARM + + + |
+
+ Properties: The properties of the Traffic Manager endpoint. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. + |
+
+(Appears on:TrafficManagerProfilesExternalEndpoint) +
+| Field | +Description | +
|---|---|
+alwaysServe+ + +EndpointProperties_AlwaysServe + + + |
+
+ AlwaysServe: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in +the traffic routing method. + |
+
+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. + |
+
+customHeaders+ + +[]EndpointProperties_CustomHeaders + + + |
+
+ CustomHeaders: List of custom headers. + |
+
+endpointLocation+ +string + + |
+
+ EndpointLocation: Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic +routing method. + |
+
+endpointMonitorStatus+ + +EndpointProperties_EndpointMonitorStatus + + + |
+
+ EndpointMonitorStatus: The monitoring status of the endpoint. + |
+
+endpointStatus+ + +EndpointProperties_EndpointStatus + + + |
+
+ EndpointStatus: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included +in the traffic routing method. + |
+
+geoMapping+ +[]string + + |
+
+ GeoMapping: The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. +Please consult Traffic Manager Geographic documentation for a full list of accepted values. + |
+
+minChildEndpoints+ +int + + |
+
+ MinChildEndpoints: The minimum number of endpoints that must be available in the child profile in order for the parent +profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. + |
+
+minChildEndpointsIPv4+ +int + + |
+
+ MinChildEndpointsIPv4: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child +profile in order for the parent profile to be considered available. Only applicable to endpoint of type +‘NestedEndpoints’. + |
+
+minChildEndpointsIPv6+ +int + + |
+
+ MinChildEndpointsIPv6: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child +profile in order for the parent profile to be considered available. Only applicable to endpoint of type +‘NestedEndpoints’. + |
+
+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 network.azure.com/TrafficManagerProfile resource + |
+
+priority+ +int + + |
+
+ Priority: The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to +1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all +endpoints, and no two endpoints can share the same priority value. + |
+
+subnets+ + +[]EndpointProperties_Subnets + + + |
+
+ Subnets: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the ‘Subnet’ +traffic routing method. An empty list will match all ranges not covered by other endpoints. + |
+
+target+ +string + + |
+
+ Target: The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses +to direct traffic to this endpoint. + |
+
+targetResourceReference+ + +genruntime.ResourceReference + + + |
+
+ TargetResourceReference: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type +‘ExternalEndpoints’. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. + |
+
+weight+ +int + + |
+
+ Weight: The weight of this endpoint when using the ‘Weighted’ traffic routing method. Possible values are from 1 to 1000. + |
+
| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+properties+ + +EndpointProperties_ARM + + + |
+
+ Properties: The properties of the Traffic Manager endpoint. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. + |
+
+(Appears on:TrafficManagerProfilesNestedEndpoint) +
+| Field | +Description | +
|---|---|
+alwaysServe+ + +EndpointProperties_AlwaysServe_STATUS + + + |
+
+ AlwaysServe: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in +the traffic routing method. + |
+
+conditions+ + +[]genruntime/conditions.Condition + + + |
+
+ Conditions: The observed state of the resource + |
+
+customHeaders+ + +[]EndpointProperties_CustomHeaders_STATUS + + + |
+
+ CustomHeaders: List of custom headers. + |
+
+endpointLocation+ +string + + |
+
+ EndpointLocation: Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic +routing method. + |
+
+endpointMonitorStatus+ + +EndpointProperties_EndpointMonitorStatus_STATUS + + + |
+
+ EndpointMonitorStatus: The monitoring status of the endpoint. + |
+
+endpointStatus+ + +EndpointProperties_EndpointStatus_STATUS + + + |
+
+ EndpointStatus: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included +in the traffic routing method. + |
+
+geoMapping+ +[]string + + |
+
+ GeoMapping: The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. +Please consult Traffic Manager Geographic documentation for a full list of accepted values. + |
+
+id+ +string + + |
+
+ Id: Fully qualified resource Id for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} + |
+
+minChildEndpoints+ +int + + |
+
+ MinChildEndpoints: The minimum number of endpoints that must be available in the child profile in order for the parent +profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. + |
+
+minChildEndpointsIPv4+ +int + + |
+
+ MinChildEndpointsIPv4: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child +profile in order for the parent profile to be considered available. Only applicable to endpoint of type +‘NestedEndpoints’. + |
+
+minChildEndpointsIPv6+ +int + + |
+
+ MinChildEndpointsIPv6: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child +profile in order for the parent profile to be considered available. Only applicable to endpoint of type +‘NestedEndpoints’. + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+priority+ +int + + |
+
+ Priority: The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to +1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all +endpoints, and no two endpoints can share the same priority value. + |
+
+subnets+ + +[]EndpointProperties_Subnets_STATUS + + + |
+
+ Subnets: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the ‘Subnet’ +traffic routing method. An empty list will match all ranges not covered by other endpoints. + |
+
+target+ +string + + |
+
+ Target: The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses +to direct traffic to this endpoint. + |
+
+targetResourceId+ +string + + |
+
+ TargetResourceId: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type ‘ExternalEndpoints’. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. + |
+
+weight+ +int + + |
+
+ Weight: The weight of this endpoint when using the ‘Weighted’ traffic routing method. Possible values are from 1 to 1000. + |
+
| Field | +Description | +
|---|---|
+id+ +string + + |
+
+ Id: Fully qualified resource Id for the resource. Ex - +/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName} + |
+
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+properties+ + +EndpointProperties_STATUS_ARM + + + |
+
+ Properties: The properties of the Traffic Manager endpoint. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. + |
+
+(Appears on:TrafficManagerProfilesNestedEndpoint) +
+| Field | +Description | +
|---|---|
+alwaysServe+ + +EndpointProperties_AlwaysServe + + + |
+
+ AlwaysServe: If Always Serve is enabled, probing for endpoint health will be disabled and endpoints will be included in +the traffic routing method. + |
+
+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. + |
+
+customHeaders+ + +[]EndpointProperties_CustomHeaders + + + |
+
+ CustomHeaders: List of custom headers. + |
+
+endpointLocation+ +string + + |
+
+ EndpointLocation: Specifies the location of the external or nested endpoints when using the ‘Performance’ traffic +routing method. + |
+
+endpointMonitorStatus+ + +EndpointProperties_EndpointMonitorStatus + + + |
+
+ EndpointMonitorStatus: The monitoring status of the endpoint. + |
+
+endpointStatus+ + +EndpointProperties_EndpointStatus + + + |
+
+ EndpointStatus: The status of the endpoint. If the endpoint is Enabled, it is probed for endpoint health and is included +in the traffic routing method. + |
+
+geoMapping+ +[]string + + |
+
+ GeoMapping: The list of countries/regions mapped to this endpoint when using the ‘Geographic’ traffic routing method. +Please consult Traffic Manager Geographic documentation for a full list of accepted values. + |
+
+minChildEndpoints+ +int + + |
+
+ MinChildEndpoints: The minimum number of endpoints that must be available in the child profile in order for the parent +profile to be considered available. Only applicable to endpoint of type ‘NestedEndpoints’. + |
+
+minChildEndpointsIPv4+ +int + + |
+
+ MinChildEndpointsIPv4: The minimum number of IPv4 (DNS record type A) endpoints that must be available in the child +profile in order for the parent profile to be considered available. Only applicable to endpoint of type +‘NestedEndpoints’. + |
+
+minChildEndpointsIPv6+ +int + + |
+
+ MinChildEndpointsIPv6: The minimum number of IPv6 (DNS record type AAAA) endpoints that must be available in the child +profile in order for the parent profile to be considered available. Only applicable to endpoint of type +‘NestedEndpoints’. + |
+
+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 network.azure.com/TrafficManagerProfile resource + |
+
+priority+ +int + + |
+
+ Priority: The priority of this endpoint when using the ‘Priority’ traffic routing method. Possible values are from 1 to +1000, lower values represent higher priority. This is an optional parameter. If specified, it must be specified on all +endpoints, and no two endpoints can share the same priority value. + |
+
+subnets+ + +[]EndpointProperties_Subnets + + + |
+
+ Subnets: The list of subnets, IP addresses, and/or address ranges mapped to this endpoint when using the ‘Subnet’ +traffic routing method. An empty list will match all ranges not covered by other endpoints. + |
+
+target+ +string + + |
+
+ Target: The fully-qualified DNS name or IP address of the endpoint. Traffic Manager returns this value in DNS responses +to direct traffic to this endpoint. + |
+
+targetResourceReference+ + +genruntime.ResourceReference + + + |
+
+ TargetResourceReference: The Azure Resource URI of the of the endpoint. Not applicable to endpoints of type +‘ExternalEndpoints’. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. + |
+
+weight+ +int + + |
+
+ Weight: The weight of this endpoint when using the ‘Weighted’ traffic routing method. Possible values are from 1 to 1000. + |
+
| Field | +Description | +
|---|---|
+name+ +string + + |
+
+ Name: The name of the resource + |
+
+properties+ + +EndpointProperties_ARM + + + |
+
+ Properties: The properties of the Traffic Manager endpoint. + |
+
+type+ +string + + |
+
+ Type: The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles. + |
+