azure.mgmt.apimanagement.models module¶

class azure.mgmt.apimanagement.models.AccessIdName(value)[source]¶

Bases: str, enum.Enum

AccessIdName.

ACCESS = 'access'¶

GIT_ACCESS = 'gitAccess'¶

class azure.mgmt.apimanagement.models.AccessInformationCollection(*, count: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged AccessInformation list representation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[AccessInformationContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

count (int) – Total record count number across all pages.

class azure.mgmt.apimanagement.models.AccessInformationContract(*, id_properties_id: Optional[str] = None, principal_id: Optional[str] = None, enabled: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Tenant Settings.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
id_properties_id (str) – Access Information type (‘access’ or ‘gitAccess’).
principal_id (str) – Principal (User) Identifier.
enabled (bool) – Determines whether direct access is enabled.

Keyword Arguments

id_properties_id (str) – Access Information type (‘access’ or ‘gitAccess’).
principal_id (str) – Principal (User) Identifier.
enabled (bool) – Determines whether direct access is enabled.

class azure.mgmt.apimanagement.models.AccessInformationCreateParameters(*, principal_id: Optional[str] = None, primary_key: Optional[str] = None, secondary_key: Optional[str] = None, enabled: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Tenant access information update parameters.

Variables

principal_id (str) – Principal (User) Identifier.
primary_key (str) – Primary access key. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
secondary_key (str) – Secondary access key. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
enabled (bool) – Determines whether direct access is enabled.

Keyword Arguments

principal_id (str) – Principal (User) Identifier.
primary_key (str) – Primary access key. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
secondary_key (str) – Secondary access key. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
enabled (bool) – Determines whether direct access is enabled.

class azure.mgmt.apimanagement.models.AccessInformationSecretsContract(*, id: Optional[str] = None, principal_id: Optional[str] = None, primary_key: Optional[str] = None, secondary_key: Optional[str] = None, enabled: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Tenant access information contract of the API Management service.

Variables

id (str) – Access Information type (‘access’ or ‘gitAccess’).
principal_id (str) – Principal (User) Identifier.
primary_key (str) – Primary access key. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
secondary_key (str) – Secondary access key. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
enabled (bool) – Determines whether direct access is enabled.

Keyword Arguments

id (str) – Access Information type (‘access’ or ‘gitAccess’).
principal_id (str) – Principal (User) Identifier.
primary_key (str) – Primary access key. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
secondary_key (str) – Secondary access key. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
enabled (bool) – Determines whether direct access is enabled.

class azure.mgmt.apimanagement.models.AccessInformationUpdateParameters(*, enabled: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Tenant access information update parameters.

Variables: enabled (bool) – Determines whether direct access is enabled.
Keyword Arguments: enabled (bool) – Determines whether direct access is enabled.

class azure.mgmt.apimanagement.models.AccessType(value)[source]¶

Bases: str, enum.Enum

The type of access to be used for the storage account.

ACCESS_KEY = 'AccessKey'¶: Use access key.

SYSTEM_ASSIGNED_MANAGED_IDENTITY = 'SystemAssignedManagedIdentity'¶: Use system assigned managed identity.

USER_ASSIGNED_MANAGED_IDENTITY = 'UserAssignedManagedIdentity'¶: Use user assigned managed identity.

class azure.mgmt.apimanagement.models.AdditionalLocation(*, location: str, sku: _models.ApiManagementServiceSkuProperties, zones: Optional[List[str]] = None, public_ip_address_id: Optional[str] = None, virtual_network_configuration: Optional[_models.VirtualNetworkConfiguration] = None, disable_gateway: bool = False, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Description of an additional API Management resource location.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

location (str) – The location name of the additional region among Azure Data center regions. Required.
sku (ApiManagementServiceSkuProperties) – SKU properties of the API Management service. Required.
zones (list[str]) – A list of availability zones denoting where the resource needs to come from.
public_ip_addresses (list[str]) – Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard, Premium and Isolated SKU.
private_ip_addresses (list[str]) – 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.
public_ip_address_id (str) – 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.
virtual_network_configuration (VirtualNetworkConfiguration) – Virtual network configuration for the location.
gateway_regional_url (str) – Gateway URL of the API Management service in the Region.
disable_gateway (bool) – Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.
platform_version (str or PlatformVersion) – Compute Platform Version running the service. Known values are: “undetermined”, “stv1”, “stv2”, and “mtv1”.

Keyword Arguments

location (str) – The location name of the additional region among Azure Data center regions. Required.
sku (ApiManagementServiceSkuProperties) – SKU properties of the API Management service. Required.
zones (list[str]) – A list of availability zones denoting where the resource needs to come from.
public_ip_address_id (str) – 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.
virtual_network_configuration (VirtualNetworkConfiguration) – Virtual network configuration for the location.
disable_gateway (bool) – Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in this additional location.

class azure.mgmt.apimanagement.models.AlwaysLog(value)[source]¶

Bases: str, enum.Enum

Specifies for what type of messages sampling settings should not apply.

ALL_ERRORS = 'allErrors'¶: Always log all erroneous request regardless of sampling settings.

class azure.mgmt.apimanagement.models.ApiCollection(*, count: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged API list representation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ApiContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

count (int) – Total record count number across all pages.

class azure.mgmt.apimanagement.models.ApiContactInformation(*, name: Optional[str] = None, url: Optional[str] = None, email: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

API contact information.

Variables

name (str) – The identifying name of the contact person/organization.
url (str) – The URL pointing to the contact information. MUST be in the format of a URL.
email (str) – The email address of the contact person/organization. MUST be in the format of an email address.

Keyword Arguments

name (str) – The identifying name of the contact person/organization.
url (str) – The URL pointing to the contact information. MUST be in the format of a URL.
email (str) – The email address of the contact person/organization. MUST be in the format of an email address.

class azure.mgmt.apimanagement.models.ApiContract(*, description: Optional[str] = None, authentication_settings: Optional[_models.AuthenticationSettingsContract] = None, subscription_key_parameter_names: Optional[_models.SubscriptionKeyParameterNamesContract] = None, api_type: Optional[Union[str, _models.ApiType]] = None, api_revision: Optional[str] = None, api_version: Optional[str] = None, is_current: Optional[bool] = None, api_revision_description: Optional[str] = None, api_version_description: Optional[str] = None, api_version_set_id: Optional[str] = None, subscription_required: Optional[bool] = None, terms_of_service_url: Optional[str] = None, contact: Optional[_models.ApiContactInformation] = None, license: Optional[_models.ApiLicenseInformation] = None, source_api_id: Optional[str] = None, display_name: Optional[str] = None, service_url: Optional[str] = None, path: Optional[str] = None, protocols: Optional[List[Union[str, _models.Protocol]]] = None, api_version_set: Optional[_models.ApiVersionSetContractDetails] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

API details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
description (str) – Description of the API. May include HTML formatting tags.
authentication_settings (AuthenticationSettingsContract) – Collection of authentication settings included into this API.
subscription_key_parameter_names (SubscriptionKeyParameterNamesContract) – Protocols over which API is made available.
api_type (str or ApiType) – Type of API. Known values are: “http”, “soap”, “websocket”, and “graphql”.
api_revision (str) – Describes the revision of the API. If no value is provided, default revision 1 is created.
api_version (str) – Indicates the version identifier of the API if the API is versioned.
is_current (bool) – Indicates if API revision is current api revision.
is_online (bool) – Indicates if API revision is accessible via the gateway.
api_revision_description (str) – Description of the API Revision.
api_version_description (str) – Description of the API Version.
api_version_set_id (str) – A resource identifier for the related ApiVersionSet.
subscription_required (bool) – Specifies whether an API or Product subscription is required for accessing the API.
terms_of_service_url (str) – A URL to the Terms of Service for the API. MUST be in the format of a URL.
contact (ApiContactInformation) – Contact information for the API.
license (ApiLicenseInformation) – License information for the API.
source_api_id (str) – API identifier of the source API.
display_name (str) – API name. Must be 1 to 300 characters long.
service_url (str) – Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
path (str) – Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
protocols (list[str or Protocol]) – Describes on which protocols the operations in this API can be invoked.
api_version_set (ApiVersionSetContractDetails) – Version set details.

Keyword Arguments

description (str) – Description of the API. May include HTML formatting tags.
authentication_settings (AuthenticationSettingsContract) – Collection of authentication settings included into this API.
subscription_key_parameter_names (SubscriptionKeyParameterNamesContract) – Protocols over which API is made available.
api_type (str or ApiType) – Type of API. Known values are: “http”, “soap”, “websocket”, and “graphql”.
api_revision (str) – Describes the revision of the API. If no value is provided, default revision 1 is created.
api_version (str) – Indicates the version identifier of the API if the API is versioned.
is_current (bool) – Indicates if API revision is current api revision.
api_revision_description (str) – Description of the API Revision.
api_version_description (str) – Description of the API Version.
api_version_set_id (str) – A resource identifier for the related ApiVersionSet.
subscription_required (bool) – Specifies whether an API or Product subscription is required for accessing the API.
terms_of_service_url (str) – A URL to the Terms of Service for the API. MUST be in the format of a URL.
contact (ApiContactInformation) – Contact information for the API.
license (ApiLicenseInformation) – License information for the API.
source_api_id (str) – API identifier of the source API.
display_name (str) – API name. Must be 1 to 300 characters long.
service_url (str) – Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
path (str) – Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
protocols (list[str or Protocol]) – Describes on which protocols the operations in this API can be invoked.
api_version_set (ApiVersionSetContractDetails) – Version set details.

class azure.mgmt.apimanagement.models.ApiContractProperties(*, path: str, description: Optional[str] = None, authentication_settings: Optional[_models.AuthenticationSettingsContract] = None, subscription_key_parameter_names: Optional[_models.SubscriptionKeyParameterNamesContract] = None, api_type: Optional[Union[str, _models.ApiType]] = None, api_revision: Optional[str] = None, api_version: Optional[str] = None, is_current: Optional[bool] = None, api_revision_description: Optional[str] = None, api_version_description: Optional[str] = None, api_version_set_id: Optional[str] = None, subscription_required: Optional[bool] = None, terms_of_service_url: Optional[str] = None, contact: Optional[_models.ApiContactInformation] = None, license: Optional[_models.ApiLicenseInformation] = None, source_api_id: Optional[str] = None, display_name: Optional[str] = None, service_url: Optional[str] = None, protocols: Optional[List[Union[str, _models.Protocol]]] = None, api_version_set: Optional[_models.ApiVersionSetContractDetails] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.ApiEntityBaseContract

API Entity Properties.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

description (str) – Description of the API. May include HTML formatting tags.
authentication_settings (AuthenticationSettingsContract) – Collection of authentication settings included into this API.
subscription_key_parameter_names (SubscriptionKeyParameterNamesContract) – Protocols over which API is made available.
api_type (str or ApiType) – Type of API. Known values are: “http”, “soap”, “websocket”, and “graphql”.
api_revision (str) – Describes the revision of the API. If no value is provided, default revision 1 is created.
api_version (str) – Indicates the version identifier of the API if the API is versioned.
is_current (bool) – Indicates if API revision is current api revision.
is_online (bool) – Indicates if API revision is accessible via the gateway.
api_revision_description (str) – Description of the API Revision.
api_version_description (str) – Description of the API Version.
api_version_set_id (str) – A resource identifier for the related ApiVersionSet.
subscription_required (bool) – Specifies whether an API or Product subscription is required for accessing the API.
terms_of_service_url (str) – A URL to the Terms of Service for the API. MUST be in the format of a URL.
contact (ApiContactInformation) – Contact information for the API.
license (ApiLicenseInformation) – License information for the API.
source_api_id (str) – API identifier of the source API.
display_name (str) – API name. Must be 1 to 300 characters long.
service_url (str) – Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
path (str) – Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. Required.
protocols (list[str or Protocol]) – Describes on which protocols the operations in this API can be invoked.
api_version_set (ApiVersionSetContractDetails) – Version set details.

Keyword Arguments

description (str) – Description of the API. May include HTML formatting tags.
authentication_settings (AuthenticationSettingsContract) – Collection of authentication settings included into this API.
subscription_key_parameter_names (SubscriptionKeyParameterNamesContract) – Protocols over which API is made available.
api_type (str or ApiType) – Type of API. Known values are: “http”, “soap”, “websocket”, and “graphql”.
api_revision (str) – Describes the revision of the API. If no value is provided, default revision 1 is created.
api_version (str) – Indicates the version identifier of the API if the API is versioned.
is_current (bool) – Indicates if API revision is current api revision.
api_revision_description (str) – Description of the API Revision.
api_version_description (str) – Description of the API Version.
api_version_set_id (str) – A resource identifier for the related ApiVersionSet.
subscription_required (bool) – Specifies whether an API or Product subscription is required for accessing the API.
terms_of_service_url (str) – A URL to the Terms of Service for the API. MUST be in the format of a URL.
contact (ApiContactInformation) – Contact information for the API.
license (ApiLicenseInformation) – License information for the API.
source_api_id (str) – API identifier of the source API.
display_name (str) – API name. Must be 1 to 300 characters long.
service_url (str) – Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
path (str) – Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. Required.
protocols (list[str or Protocol]) – Describes on which protocols the operations in this API can be invoked.
api_version_set (ApiVersionSetContractDetails) – Version set details.

class azure.mgmt.apimanagement.models.ApiContractUpdateProperties(*, description: Optional[str] = None, authentication_settings: Optional[_models.AuthenticationSettingsContract] = None, subscription_key_parameter_names: Optional[_models.SubscriptionKeyParameterNamesContract] = None, api_type: Optional[Union[str, _models.ApiType]] = None, api_revision: Optional[str] = None, api_version: Optional[str] = None, is_current: Optional[bool] = None, api_revision_description: Optional[str] = None, api_version_description: Optional[str] = None, api_version_set_id: Optional[str] = None, subscription_required: Optional[bool] = None, terms_of_service_url: Optional[str] = None, contact: Optional[_models.ApiContactInformation] = None, license: Optional[_models.ApiLicenseInformation] = None, display_name: Optional[str] = None, service_url: Optional[str] = None, path: Optional[str] = None, protocols: Optional[List[Union[str, _models.Protocol]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.ApiEntityBaseContract

API update contract properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

description (str) – Description of the API. May include HTML formatting tags.
authentication_settings (AuthenticationSettingsContract) – Collection of authentication settings included into this API.
subscription_key_parameter_names (SubscriptionKeyParameterNamesContract) – Protocols over which API is made available.
api_type (str or ApiType) – Type of API. Known values are: “http”, “soap”, “websocket”, and “graphql”.
api_revision (str) – Describes the revision of the API. If no value is provided, default revision 1 is created.
api_version (str) – Indicates the version identifier of the API if the API is versioned.
is_current (bool) – Indicates if API revision is current api revision.
is_online (bool) – Indicates if API revision is accessible via the gateway.
api_revision_description (str) – Description of the API Revision.
api_version_description (str) – Description of the API Version.
api_version_set_id (str) – A resource identifier for the related ApiVersionSet.
subscription_required (bool) – Specifies whether an API or Product subscription is required for accessing the API.
terms_of_service_url (str) – A URL to the Terms of Service for the API. MUST be in the format of a URL.
contact (ApiContactInformation) – Contact information for the API.
license (ApiLicenseInformation) – License information for the API.
display_name (str) – API name.
service_url (str) – Absolute URL of the backend service implementing this API.
path (str) – Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
protocols (list[str or Protocol]) – Describes on which protocols the operations in this API can be invoked.

Keyword Arguments

description (str) – Description of the API. May include HTML formatting tags.
authentication_settings (AuthenticationSettingsContract) – Collection of authentication settings included into this API.
subscription_key_parameter_names (SubscriptionKeyParameterNamesContract) – Protocols over which API is made available.
api_type (str or ApiType) – Type of API. Known values are: “http”, “soap”, “websocket”, and “graphql”.
api_revision (str) – Describes the revision of the API. If no value is provided, default revision 1 is created.
api_version (str) – Indicates the version identifier of the API if the API is versioned.
is_current (bool) – Indicates if API revision is current api revision.
api_revision_description (str) – Description of the API Revision.
api_version_description (str) – Description of the API Version.
api_version_set_id (str) – A resource identifier for the related ApiVersionSet.
subscription_required (bool) – Specifies whether an API or Product subscription is required for accessing the API.
terms_of_service_url (str) – A URL to the Terms of Service for the API. MUST be in the format of a URL.
contact (ApiContactInformation) – Contact information for the API.
license (ApiLicenseInformation) – License information for the API.
display_name (str) – API name.
service_url (str) – Absolute URL of the backend service implementing this API.
path (str) – Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
protocols (list[str or Protocol]) – Describes on which protocols the operations in this API can be invoked.

class azure.mgmt.apimanagement.models.ApiCreateOrUpdateParameter(*, description: Optional[str] = None, authentication_settings: Optional[_models.AuthenticationSettingsContract] = None, subscription_key_parameter_names: Optional[_models.SubscriptionKeyParameterNamesContract] = None, api_type: Optional[Union[str, _models.ApiType]] = None, api_revision: Optional[str] = None, api_version: Optional[str] = None, is_current: Optional[bool] = None, api_revision_description: Optional[str] = None, api_version_description: Optional[str] = None, api_version_set_id: Optional[str] = None, subscription_required: Optional[bool] = None, terms_of_service_url: Optional[str] = None, contact: Optional[_models.ApiContactInformation] = None, license: Optional[_models.ApiLicenseInformation] = None, source_api_id: Optional[str] = None, display_name: Optional[str] = None, service_url: Optional[str] = None, path: Optional[str] = None, protocols: Optional[List[Union[str, _models.Protocol]]] = None, api_version_set: Optional[_models.ApiVersionSetContractDetails] = None, value: Optional[str] = None, format: Optional[Union[str, _models.ContentFormat]] = None, wsdl_selector: Optional[_models.ApiCreateOrUpdatePropertiesWsdlSelector] = None, soap_api_type: Optional[Union[str, _models.SoapApiType]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

API Create or Update Parameters.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

description (str) – Description of the API. May include HTML formatting tags.
authentication_settings (AuthenticationSettingsContract) – Collection of authentication settings included into this API.
subscription_key_parameter_names (SubscriptionKeyParameterNamesContract) – Protocols over which API is made available.
api_type (str or ApiType) – Type of API. Known values are: “http”, “soap”, “websocket”, and “graphql”.
api_revision (str) – Describes the revision of the API. If no value is provided, default revision 1 is created.
api_version (str) – Indicates the version identifier of the API if the API is versioned.
is_current (bool) – Indicates if API revision is current api revision.
is_online (bool) – Indicates if API revision is accessible via the gateway.
api_revision_description (str) – Description of the API Revision.
api_version_description (str) – Description of the API Version.
api_version_set_id (str) – A resource identifier for the related ApiVersionSet.
subscription_required (bool) – Specifies whether an API or Product subscription is required for accessing the API.
terms_of_service_url (str) – A URL to the Terms of Service for the API. MUST be in the format of a URL.
contact (ApiContactInformation) – Contact information for the API.
license (ApiLicenseInformation) – License information for the API.
source_api_id (str) – API identifier of the source API.
display_name (str) – API name. Must be 1 to 300 characters long.
service_url (str) – Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
path (str) – Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
protocols (list[str or Protocol]) – Describes on which protocols the operations in this API can be invoked.
api_version_set (ApiVersionSetContractDetails) – Version set details.
value (str) – Content value when Importing an API.
format (str or ContentFormat) – Format of the Content in which the API is getting imported. Known values are: “wadl-xml”, “wadl-link-json”, “swagger-json”, “swagger-link-json”, “wsdl”, “wsdl-link”, “openapi”, “openapi+json”, “openapi-link”, “openapi+json-link”, and “graphql-link”.
wsdl_selector (ApiCreateOrUpdatePropertiesWsdlSelector) – Criteria to limit import of WSDL to a subset of the document.
soap_api_type (str or SoapApiType) –
Type of API to create.
- http creates a REST API
- soap creates a SOAP pass-through API
- websocket creates websocket API
- graphql creates GraphQL API. Known values are: “http”, “soap”, “websocket”, and
”graphql”.

Keyword Arguments

description (str) – Description of the API. May include HTML formatting tags.
authentication_settings (AuthenticationSettingsContract) – Collection of authentication settings included into this API.
subscription_key_parameter_names (SubscriptionKeyParameterNamesContract) – Protocols over which API is made available.
api_type (str or ApiType) – Type of API. Known values are: “http”, “soap”, “websocket”, and “graphql”.
api_revision (str) – Describes the revision of the API. If no value is provided, default revision 1 is created.
api_version (str) – Indicates the version identifier of the API if the API is versioned.
is_current (bool) – Indicates if API revision is current api revision.
api_revision_description (str) – Description of the API Revision.
api_version_description (str) – Description of the API Version.
api_version_set_id (str) – A resource identifier for the related ApiVersionSet.
subscription_required (bool) – Specifies whether an API or Product subscription is required for accessing the API.
terms_of_service_url (str) – A URL to the Terms of Service for the API. MUST be in the format of a URL.
contact (ApiContactInformation) – Contact information for the API.
license (ApiLicenseInformation) – License information for the API.
source_api_id (str) – API identifier of the source API.
display_name (str) – API name. Must be 1 to 300 characters long.
service_url (str) – Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
path (str) – Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
protocols (list[str or Protocol]) – Describes on which protocols the operations in this API can be invoked.
api_version_set (ApiVersionSetContractDetails) – Version set details.
value (str) – Content value when Importing an API.
format (str or ContentFormat) – Format of the Content in which the API is getting imported. Known values are: “wadl-xml”, “wadl-link-json”, “swagger-json”, “swagger-link-json”, “wsdl”, “wsdl-link”, “openapi”, “openapi+json”, “openapi-link”, “openapi+json-link”, and “graphql-link”.
wsdl_selector (ApiCreateOrUpdatePropertiesWsdlSelector) – Criteria to limit import of WSDL to a subset of the document.
soap_api_type (str or SoapApiType) –
Type of API to create.
- http creates a REST API
- soap creates a SOAP pass-through API
- websocket creates websocket API
- graphql creates GraphQL API. Known values are: “http”, “soap”, “websocket”, and
”graphql”.

class azure.mgmt.apimanagement.models.ApiCreateOrUpdateProperties(*, path: str, description: Optional[str] = None, authentication_settings: Optional[_models.AuthenticationSettingsContract] = None, subscription_key_parameter_names: Optional[_models.SubscriptionKeyParameterNamesContract] = None, api_type: Optional[Union[str, _models.ApiType]] = None, api_revision: Optional[str] = None, api_version: Optional[str] = None, is_current: Optional[bool] = None, api_revision_description: Optional[str] = None, api_version_description: Optional[str] = None, api_version_set_id: Optional[str] = None, subscription_required: Optional[bool] = None, terms_of_service_url: Optional[str] = None, contact: Optional[_models.ApiContactInformation] = None, license: Optional[_models.ApiLicenseInformation] = None, source_api_id: Optional[str] = None, display_name: Optional[str] = None, service_url: Optional[str] = None, protocols: Optional[List[Union[str, _models.Protocol]]] = None, api_version_set: Optional[_models.ApiVersionSetContractDetails] = None, value: Optional[str] = None, format: Optional[Union[str, _models.ContentFormat]] = None, wsdl_selector: Optional[_models.ApiCreateOrUpdatePropertiesWsdlSelector] = None, soap_api_type: Optional[Union[str, _models.SoapApiType]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.ApiContractProperties

API Create or Update Properties.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

description (str) – Description of the API. May include HTML formatting tags.
authentication_settings (AuthenticationSettingsContract) – Collection of authentication settings included into this API.
subscription_key_parameter_names (SubscriptionKeyParameterNamesContract) – Protocols over which API is made available.
api_type (str or ApiType) – Type of API. Known values are: “http”, “soap”, “websocket”, and “graphql”.
api_revision (str) – Describes the revision of the API. If no value is provided, default revision 1 is created.
api_version (str) – Indicates the version identifier of the API if the API is versioned.
is_current (bool) – Indicates if API revision is current api revision.
is_online (bool) – Indicates if API revision is accessible via the gateway.
api_revision_description (str) – Description of the API Revision.
api_version_description (str) – Description of the API Version.
api_version_set_id (str) – A resource identifier for the related ApiVersionSet.
subscription_required (bool) – Specifies whether an API or Product subscription is required for accessing the API.
terms_of_service_url (str) – A URL to the Terms of Service for the API. MUST be in the format of a URL.
contact (ApiContactInformation) – Contact information for the API.
license (ApiLicenseInformation) – License information for the API.
source_api_id (str) – API identifier of the source API.
display_name (str) – API name. Must be 1 to 300 characters long.
service_url (str) – Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
path (str) – Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. Required.
protocols (list[str or Protocol]) – Describes on which protocols the operations in this API can be invoked.
api_version_set (ApiVersionSetContractDetails) – Version set details.
value (str) – Content value when Importing an API.
format (str or ContentFormat) – Format of the Content in which the API is getting imported. Known values are: “wadl-xml”, “wadl-link-json”, “swagger-json”, “swagger-link-json”, “wsdl”, “wsdl-link”, “openapi”, “openapi+json”, “openapi-link”, “openapi+json-link”, and “graphql-link”.
wsdl_selector (ApiCreateOrUpdatePropertiesWsdlSelector) – Criteria to limit import of WSDL to a subset of the document.
soap_api_type (str or SoapApiType) –
Type of API to create.
- http creates a REST API
- soap creates a SOAP pass-through API
- websocket creates websocket API
- graphql creates GraphQL API. Known values are: “http”, “soap”, “websocket”, and
”graphql”.

Keyword Arguments

description (str) – Description of the API. May include HTML formatting tags.
authentication_settings (AuthenticationSettingsContract) – Collection of authentication settings included into this API.
subscription_key_parameter_names (SubscriptionKeyParameterNamesContract) – Protocols over which API is made available.
api_type (str or ApiType) – Type of API. Known values are: “http”, “soap”, “websocket”, and “graphql”.
api_revision (str) – Describes the revision of the API. If no value is provided, default revision 1 is created.
api_version (str) – Indicates the version identifier of the API if the API is versioned.
is_current (bool) – Indicates if API revision is current api revision.
api_revision_description (str) – Description of the API Revision.
api_version_description (str) – Description of the API Version.
api_version_set_id (str) – A resource identifier for the related ApiVersionSet.
subscription_required (bool) – Specifies whether an API or Product subscription is required for accessing the API.
terms_of_service_url (str) – A URL to the Terms of Service for the API. MUST be in the format of a URL.
contact (ApiContactInformation) – Contact information for the API.
license (ApiLicenseInformation) – License information for the API.
source_api_id (str) – API identifier of the source API.
display_name (str) – API name. Must be 1 to 300 characters long.
service_url (str) – Absolute URL of the backend service implementing this API. Cannot be more than 2000 characters long.
path (str) – Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API. Required.
protocols (list[str or Protocol]) – Describes on which protocols the operations in this API can be invoked.
api_version_set (ApiVersionSetContractDetails) – Version set details.
value (str) – Content value when Importing an API.
format (str or ContentFormat) – Format of the Content in which the API is getting imported. Known values are: “wadl-xml”, “wadl-link-json”, “swagger-json”, “swagger-link-json”, “wsdl”, “wsdl-link”, “openapi”, “openapi+json”, “openapi-link”, “openapi+json-link”, and “graphql-link”.
wsdl_selector (ApiCreateOrUpdatePropertiesWsdlSelector) – Criteria to limit import of WSDL to a subset of the document.
soap_api_type (str or SoapApiType) –
Type of API to create.
- http creates a REST API
- soap creates a SOAP pass-through API
- websocket creates websocket API
- graphql creates GraphQL API. Known values are: “http”, “soap”, “websocket”, and
”graphql”.

class azure.mgmt.apimanagement.models.ApiCreateOrUpdatePropertiesWsdlSelector(*, wsdl_service_name: Optional[str] = None, wsdl_endpoint_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Criteria to limit import of WSDL to a subset of the document.

Variables

wsdl_service_name (str) – Name of service to import from WSDL.
wsdl_endpoint_name (str) – Name of endpoint(port) to import from WSDL.

Keyword Arguments

wsdl_service_name (str) – Name of service to import from WSDL.
wsdl_endpoint_name (str) – Name of endpoint(port) to import from WSDL.

class azure.mgmt.apimanagement.models.ApiEntityBaseContract(*, description: Optional[str] = None, authentication_settings: Optional[_models.AuthenticationSettingsContract] = None, subscription_key_parameter_names: Optional[_models.SubscriptionKeyParameterNamesContract] = None, api_type: Optional[Union[str, _models.ApiType]] = None, api_revision: Optional[str] = None, api_version: Optional[str] = None, is_current: Optional[bool] = None, api_revision_description: Optional[str] = None, api_version_description: Optional[str] = None, api_version_set_id: Optional[str] = None, subscription_required: Optional[bool] = None, terms_of_service_url: Optional[str] = None, contact: Optional[_models.ApiContactInformation] = None, license: Optional[_models.ApiLicenseInformation] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

API base contract details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

description (str) – Description of the API. May include HTML formatting tags.
authentication_settings (AuthenticationSettingsContract) – Collection of authentication settings included into this API.
subscription_key_parameter_names (SubscriptionKeyParameterNamesContract) – Protocols over which API is made available.
api_type (str or ApiType) – Type of API. Known values are: “http”, “soap”, “websocket”, and “graphql”.
api_revision (str) – Describes the revision of the API. If no value is provided, default revision 1 is created.
api_version (str) – Indicates the version identifier of the API if the API is versioned.
is_current (bool) – Indicates if API revision is current api revision.
is_online (bool) – Indicates if API revision is accessible via the gateway.
api_revision_description (str) – Description of the API Revision.
api_version_description (str) – Description of the API Version.
api_version_set_id (str) – A resource identifier for the related ApiVersionSet.
subscription_required (bool) – Specifies whether an API or Product subscription is required for accessing the API.
terms_of_service_url (str) – A URL to the Terms of Service for the API. MUST be in the format of a URL.
contact (ApiContactInformation) – Contact information for the API.
license (ApiLicenseInformation) – License information for the API.

Keyword Arguments

description (str) – Description of the API. May include HTML formatting tags.
authentication_settings (AuthenticationSettingsContract) – Collection of authentication settings included into this API.
subscription_key_parameter_names (SubscriptionKeyParameterNamesContract) – Protocols over which API is made available.
api_type (str or ApiType) – Type of API. Known values are: “http”, “soap”, “websocket”, and “graphql”.
api_revision (str) – Describes the revision of the API. If no value is provided, default revision 1 is created.
api_version (str) – Indicates the version identifier of the API if the API is versioned.
is_current (bool) – Indicates if API revision is current api revision.
api_revision_description (str) – Description of the API Revision.
api_version_description (str) – Description of the API Version.
api_version_set_id (str) – A resource identifier for the related ApiVersionSet.
subscription_required (bool) – Specifies whether an API or Product subscription is required for accessing the API.
terms_of_service_url (str) – A URL to the Terms of Service for the API. MUST be in the format of a URL.
contact (ApiContactInformation) – Contact information for the API.
license (ApiLicenseInformation) – License information for the API.

class azure.mgmt.apimanagement.models.ApiExportResult(*, id: Optional[str] = None, export_result_format: Optional[Union[str, _models.ExportResultFormat]] = None, value: Optional[_models.ApiExportResultValue] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

API Export result.

Variables

id (str) – ResourceId of the API which was exported.
export_result_format (str or ExportResultFormat) – Format in which the API Details are exported to the Storage Blob with Sas Key valid for 5 minutes. Known values are: “swagger-link-json”, “wsdl-link+xml”, “wadl-link-json”, and “openapi-link”.
value (ApiExportResultValue) – The object defining the schema of the exported API Detail.

Keyword Arguments

id (str) – ResourceId of the API which was exported.
export_result_format (str or ExportResultFormat) – Format in which the API Details are exported to the Storage Blob with Sas Key valid for 5 minutes. Known values are: “swagger-link-json”, “wsdl-link+xml”, “wadl-link-json”, and “openapi-link”.
value (ApiExportResultValue) – The object defining the schema of the exported API Detail.

class azure.mgmt.apimanagement.models.ApiExportResultValue(*, link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

The object defining the schema of the exported API Detail.

Variables: link (str) – Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes.
Keyword Arguments: link (str) – Link to the Storage Blob containing the result of the export operation. The Blob Uri is only valid for 5 minutes.

class azure.mgmt.apimanagement.models.ApiLicenseInformation(*, name: Optional[str] = None, url: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

API license information.

Variables

name (str) – The license name used for the API.
url (str) – A URL to the license used for the API. MUST be in the format of a URL.

Keyword Arguments

name (str) – The license name used for the API.
url (str) – A URL to the license used for the API. MUST be in the format of a URL.

class azure.mgmt.apimanagement.models.ApiManagementServiceApplyNetworkConfigurationParameters(*, location: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Parameter supplied to the Apply Network configuration operation.

Variables: location (str) – Location of the Api Management service to update for a multi-region service. For a service deployed in a single region, this parameter is not required.
Keyword Arguments: location (str) – Location of the Api Management service to update for a multi-region service. For a service deployed in a single region, this parameter is not required.

class azure.mgmt.apimanagement.models.ApiManagementServiceBackupRestoreParameters(*, storage_account: str, container_name: str, backup_name: str, access_type: Union[str, _models.AccessType] = 'AccessKey', access_key: Optional[str] = None, client_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Parameters supplied to the Backup/Restore of an API Management service operation.

All required parameters must be populated in order to send to Azure.

Variables

storage_account (str) – The name of the Azure storage account (used to place/retrieve the backup). Required.
container_name (str) – The name of the blob container (used to place/retrieve the backup). Required.
backup_name (str) – The name of the backup file to create/retrieve. Required.
access_type (str or AccessType) – The type of access to be used for the storage account. Known values are: “AccessKey”, “SystemAssignedManagedIdentity”, and “UserAssignedManagedIdentity”.
access_key (str) – Storage account access key. Required only if accessType is set to AccessKey.
client_id (str) – The Client ID of user assigned managed identity. Required only if accessType is set to UserAssignedManagedIdentity.

Keyword Arguments

storage_account (str) – The name of the Azure storage account (used to place/retrieve the backup). Required.
container_name (str) – The name of the blob container (used to place/retrieve the backup). Required.
backup_name (str) – The name of the backup file to create/retrieve. Required.
access_type (str or AccessType) – The type of access to be used for the storage account. Known values are: “AccessKey”, “SystemAssignedManagedIdentity”, and “UserAssignedManagedIdentity”.
access_key (str) – Storage account access key. Required only if accessType is set to AccessKey.
client_id (str) – The Client ID of user assigned managed identity. Required only if accessType is set to UserAssignedManagedIdentity.

class azure.mgmt.apimanagement.models.ApiManagementServiceBaseProperties(*, notification_sender_email: Optional[str] = None, hostname_configurations: Optional[List[_models.HostnameConfiguration]] = None, public_ip_address_id: Optional[str] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, virtual_network_configuration: Optional[_models.VirtualNetworkConfiguration] = None, additional_locations: Optional[List[_models.AdditionalLocation]] = None, custom_properties: Optional[Dict[str, str]] = None, certificates: Optional[List[_models.CertificateConfiguration]] = None, enable_client_certificate: bool = False, disable_gateway: bool = False, virtual_network_type: Union[str, _models.VirtualNetworkType] = 'None', api_version_constraint: Optional[_models.ApiVersionConstraint] = None, restore: bool = False, private_endpoint_connections: Optional[List[_models.RemotePrivateEndpointConnectionWrapper]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Base Properties of an API Management service resource description.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

notification_sender_email (str) – Email address from which the notification will be sent.
provisioning_state (str) – 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.
target_provisioning_state (str) – The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
created_at_utc (datetime) – Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
gateway_url (str) – Gateway URL of the API Management service.
gateway_regional_url (str) – Gateway URL of the API Management service in the Default Region.
portal_url (str) – Publisher portal endpoint Url of the API Management service.
management_api_url (str) – Management API endpoint URL of the API Management service.
scm_url (str) – SCM endpoint URL of the API Management service.
developer_portal_url (str) – DEveloper Portal endpoint URL of the API Management service.
hostname_configurations (list[HostnameConfiguration]) – Custom hostname configuration of the API Management service.
public_ip_addresses (list[str]) – Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.
private_ip_addresses (list[str]) – 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.
public_ip_address_id (str) – 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.
public_network_access (str or 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’. Known values are: “Enabled” and “Disabled”.
virtual_network_configuration (VirtualNetworkConfiguration) – Virtual network configuration of the API Management service.
additional_locations (list[AdditionalLocation]) – Additional datacenter locations of the API Management service.
custom_properties (dict[str, str]) – Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties’ values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting’s default value is False.You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256: false. The default value is true for them. Note: next ciphers can’t be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384.
certificates (list[CertificateConfiguration]) – List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
enable_client_certificate (bool) – 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.
disable_gateway (bool) – Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
virtual_network_type (str or 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. Known values are: “None”, “External”, and “Internal”.
api_version_constraint (ApiVersionConstraint) – Control Plane Apis version constraint for the API Management service.
restore (bool) – 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.
private_endpoint_connections (list[RemotePrivateEndpointConnectionWrapper]) – List of Private Endpoint Connections of this service.
platform_version (str or PlatformVersion) – Compute Platform Version running the service in this location. Known values are: “undetermined”, “stv1”, “stv2”, and “mtv1”.

Keyword Arguments

notification_sender_email (str) – Email address from which the notification will be sent.
hostname_configurations (list[HostnameConfiguration]) – Custom hostname configuration of the API Management service.
public_ip_address_id (str) – 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.
public_network_access (str or 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’. Known values are: “Enabled” and “Disabled”.
virtual_network_configuration (VirtualNetworkConfiguration) – Virtual network configuration of the API Management service.
additional_locations (list[AdditionalLocation]) – Additional datacenter locations of the API Management service.
custom_properties (dict[str, str]) – Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties’ values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting’s default value is False.You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256: false. The default value is true for them. Note: next ciphers can’t be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384.
certificates (list[CertificateConfiguration]) – List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
enable_client_certificate (bool) – 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.
disable_gateway (bool) – Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
virtual_network_type (str or 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. Known values are: “None”, “External”, and “Internal”.
api_version_constraint (ApiVersionConstraint) – Control Plane Apis version constraint for the API Management service.
restore (bool) – 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.
private_endpoint_connections (list[RemotePrivateEndpointConnectionWrapper]) – List of Private Endpoint Connections of this service.

class azure.mgmt.apimanagement.models.ApiManagementServiceCheckNameAvailabilityParameters(*, name: str, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Parameters supplied to the CheckNameAvailability operation.

All required parameters must be populated in order to send to Azure.

Variables: name (str) – The name to check for availability. Required.
Keyword Arguments: name (str) – The name to check for availability. Required.

class azure.mgmt.apimanagement.models.ApiManagementServiceGetDomainOwnershipIdentifierResult(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Response of the GetDomainOwnershipIdentifier operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: domain_ownership_identifier (str) – The domain ownership identifier value.

class azure.mgmt.apimanagement.models.ApiManagementServiceGetSsoTokenResult(*, redirect_uri: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

The response of the GetSsoToken operation.

Variables: redirect_uri (str) – Redirect URL to the Publisher Portal containing the SSO token.
Keyword Arguments: redirect_uri (str) – Redirect URL to the Publisher Portal containing the SSO token.

class azure.mgmt.apimanagement.models.ApiManagementServiceIdentity(*, type: Union[str, _models.ApimIdentityType], user_assigned_identities: Optional[Dict[str, _models.UserIdentityProperties]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Identity properties of the Api Management service resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

type (str or ApimIdentityType) – 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. Required. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.
principal_id (str) – The principal id of the identity.
tenant_id (str) – The client tenant id of the identity.
user_assigned_identities (dict[str, UserIdentityProperties]) –
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}’.

Keyword Arguments

type (str or ApimIdentityType) – 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. Required. Known values are: “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”, and “None”.
user_assigned_identities (dict[str, UserIdentityProperties]) –
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}’.

class azure.mgmt.apimanagement.models.ApiManagementServiceListResult(*, value: List[_models.ApiManagementServiceResource], next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

The response of the List API Management services operation.

All required parameters must be populated in order to send to Azure.

Variables

value (list[ApiManagementServiceResource]) – Result of the List API Management services operation. Required.
next_link (str) – Link to the next set of results. Not empty if Value contains incomplete list of API Management services.

Keyword Arguments

value (list[ApiManagementServiceResource]) – Result of the List API Management services operation. Required.
next_link (str) – Link to the next set of results. Not empty if Value contains incomplete list of API Management services.

class azure.mgmt.apimanagement.models.ApiManagementServiceNameAvailabilityResult(*, reason: Optional[Union[str, _models.NameAvailabilityReason]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Response of the CheckNameAvailability operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name_available (bool) – True if the name is available and can be used to create a new API Management service; otherwise false.
message (str) – If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that <resourceName> is already in use, and direct them to select a different name.
reason (str or NameAvailabilityReason) – Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable. Known values are: “Valid”, “Invalid”, and “AlreadyExists”.

Keyword Arguments

reason (str or NameAvailabilityReason) – Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable. Known values are: “Valid”, “Invalid”, and “AlreadyExists”.

class azure.mgmt.apimanagement.models.ApiManagementServiceProperties(*, publisher_email: str, publisher_name: str, notification_sender_email: Optional[str] = None, hostname_configurations: Optional[List[_models.HostnameConfiguration]] = None, public_ip_address_id: Optional[str] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, virtual_network_configuration: Optional[_models.VirtualNetworkConfiguration] = None, additional_locations: Optional[List[_models.AdditionalLocation]] = None, custom_properties: Optional[Dict[str, str]] = None, certificates: Optional[List[_models.CertificateConfiguration]] = None, enable_client_certificate: bool = False, disable_gateway: bool = False, virtual_network_type: Union[str, _models.VirtualNetworkType] = 'None', api_version_constraint: Optional[_models.ApiVersionConstraint] = None, restore: bool = False, private_endpoint_connections: Optional[List[_models.RemotePrivateEndpointConnectionWrapper]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.ApiManagementServiceBaseProperties

Properties of an API Management service resource description.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

notification_sender_email (str) – Email address from which the notification will be sent.
provisioning_state (str) – 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.
target_provisioning_state (str) – The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
created_at_utc (datetime) – Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
gateway_url (str) – Gateway URL of the API Management service.
gateway_regional_url (str) – Gateway URL of the API Management service in the Default Region.
portal_url (str) – Publisher portal endpoint Url of the API Management service.
management_api_url (str) – Management API endpoint URL of the API Management service.
scm_url (str) – SCM endpoint URL of the API Management service.
developer_portal_url (str) – DEveloper Portal endpoint URL of the API Management service.
hostname_configurations (list[HostnameConfiguration]) – Custom hostname configuration of the API Management service.
public_ip_addresses (list[str]) – Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.
private_ip_addresses (list[str]) – 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.
public_ip_address_id (str) – 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.
public_network_access (str or 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’. Known values are: “Enabled” and “Disabled”.
virtual_network_configuration (VirtualNetworkConfiguration) – Virtual network configuration of the API Management service.
additional_locations (list[AdditionalLocation]) – Additional datacenter locations of the API Management service.
custom_properties (dict[str, str]) – Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties’ values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting’s default value is False.You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256: false. The default value is true for them. Note: next ciphers can’t be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384.
certificates (list[CertificateConfiguration]) – List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
enable_client_certificate (bool) – 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.
disable_gateway (bool) – Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
virtual_network_type (str or 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. Known values are: “None”, “External”, and “Internal”.
api_version_constraint (ApiVersionConstraint) – Control Plane Apis version constraint for the API Management service.
restore (bool) – 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.
private_endpoint_connections (list[RemotePrivateEndpointConnectionWrapper]) – List of Private Endpoint Connections of this service.
platform_version (str or PlatformVersion) – Compute Platform Version running the service in this location. Known values are: “undetermined”, “stv1”, “stv2”, and “mtv1”.
publisher_email (str) – Publisher email. Required.
publisher_name (str) – Publisher name. Required.

Keyword Arguments

notification_sender_email (str) – Email address from which the notification will be sent.
hostname_configurations (list[HostnameConfiguration]) – Custom hostname configuration of the API Management service.
public_ip_address_id (str) – 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.
public_network_access (str or 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’. Known values are: “Enabled” and “Disabled”.
virtual_network_configuration (VirtualNetworkConfiguration) – Virtual network configuration of the API Management service.
additional_locations (list[AdditionalLocation]) – Additional datacenter locations of the API Management service.
custom_properties (dict[str, str]) – Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties’ values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting’s default value is False.You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256: false. The default value is true for them. Note: next ciphers can’t be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384.
certificates (list[CertificateConfiguration]) – List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
enable_client_certificate (bool) – 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.
disable_gateway (bool) – Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
virtual_network_type (str or 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. Known values are: “None”, “External”, and “Internal”.
api_version_constraint (ApiVersionConstraint) – Control Plane Apis version constraint for the API Management service.
restore (bool) – 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.
private_endpoint_connections (list[RemotePrivateEndpointConnectionWrapper]) – List of Private Endpoint Connections of this service.
publisher_email (str) – Publisher email. Required.
publisher_name (str) – Publisher name. Required.

class azure.mgmt.apimanagement.models.ApiManagementServiceResource(*, sku: _models.ApiManagementServiceSkuProperties, location: str, publisher_email: str, publisher_name: str, tags: Optional[Dict[str, str]] = None, identity: Optional[_models.ApiManagementServiceIdentity] = None, zones: Optional[List[str]] = None, notification_sender_email: Optional[str] = None, hostname_configurations: Optional[List[_models.HostnameConfiguration]] = None, public_ip_address_id: Optional[str] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, virtual_network_configuration: Optional[_models.VirtualNetworkConfiguration] = None, additional_locations: Optional[List[_models.AdditionalLocation]] = None, custom_properties: Optional[Dict[str, str]] = None, certificates: Optional[List[_models.CertificateConfiguration]] = None, enable_client_certificate: bool = False, disable_gateway: bool = False, virtual_network_type: Union[str, _models.VirtualNetworkType] = 'None', api_version_constraint: Optional[_models.ApiVersionConstraint] = None, restore: bool = False, private_endpoint_connections: Optional[List[_models.RemotePrivateEndpointConnectionWrapper]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.ApimResource

A single API Management service resource in List or Get response.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type for API Management resource is set to Microsoft.ApiManagement.
tags (dict[str, str]) – Resource tags.
sku (ApiManagementServiceSkuProperties) – SKU properties of the API Management service. Required.
identity (ApiManagementServiceIdentity) – Managed service identity of the Api Management service.
system_data (SystemData) – Metadata pertaining to creation and last modification of the resource.
location (str) – Resource location. Required.
etag (str) – ETag of the resource.
zones (list[str]) – A list of availability zones denoting where the resource needs to come from.
notification_sender_email (str) – Email address from which the notification will be sent.
provisioning_state (str) – 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.
target_provisioning_state (str) – The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
created_at_utc (datetime) – Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
gateway_url (str) – Gateway URL of the API Management service.
gateway_regional_url (str) – Gateway URL of the API Management service in the Default Region.
portal_url (str) – Publisher portal endpoint Url of the API Management service.
management_api_url (str) – Management API endpoint URL of the API Management service.
scm_url (str) – SCM endpoint URL of the API Management service.
developer_portal_url (str) – DEveloper Portal endpoint URL of the API Management service.
hostname_configurations (list[HostnameConfiguration]) – Custom hostname configuration of the API Management service.
public_ip_addresses (list[str]) – Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.
private_ip_addresses (list[str]) – 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.
public_ip_address_id (str) – 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.
public_network_access (str or 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’. Known values are: “Enabled” and “Disabled”.
virtual_network_configuration (VirtualNetworkConfiguration) – Virtual network configuration of the API Management service.
additional_locations (list[AdditionalLocation]) – Additional datacenter locations of the API Management service.
custom_properties (dict[str, str]) – Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties’ values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting’s default value is False.You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256: false. The default value is true for them. Note: next ciphers can’t be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384.
certificates (list[CertificateConfiguration]) – List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
enable_client_certificate (bool) – 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.
disable_gateway (bool) – Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
virtual_network_type (str or 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. Known values are: “None”, “External”, and “Internal”.
api_version_constraint (ApiVersionConstraint) – Control Plane Apis version constraint for the API Management service.
restore (bool) – 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.
private_endpoint_connections (list[RemotePrivateEndpointConnectionWrapper]) – List of Private Endpoint Connections of this service.
platform_version (str or PlatformVersion) – Compute Platform Version running the service in this location. Known values are: “undetermined”, “stv1”, “stv2”, and “mtv1”.
publisher_email (str) – Publisher email. Required.
publisher_name (str) – Publisher name. Required.

Keyword Arguments

tags (dict[str, str]) – Resource tags.
sku (ApiManagementServiceSkuProperties) – SKU properties of the API Management service. Required.
identity (ApiManagementServiceIdentity) – Managed service identity of the Api Management service.
location (str) – Resource location. Required.
zones (list[str]) – A list of availability zones denoting where the resource needs to come from.
notification_sender_email (str) – Email address from which the notification will be sent.
hostname_configurations (list[HostnameConfiguration]) – Custom hostname configuration of the API Management service.
public_ip_address_id (str) – 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.
public_network_access (str or 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’. Known values are: “Enabled” and “Disabled”.
virtual_network_configuration (VirtualNetworkConfiguration) – Virtual network configuration of the API Management service.
additional_locations (list[AdditionalLocation]) – Additional datacenter locations of the API Management service.
custom_properties (dict[str, str]) – Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties’ values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting’s default value is False.You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256: false. The default value is true for them. Note: next ciphers can’t be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384.
certificates (list[CertificateConfiguration]) – List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
enable_client_certificate (bool) – 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.
disable_gateway (bool) – Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
virtual_network_type (str or 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. Known values are: “None”, “External”, and “Internal”.
api_version_constraint (ApiVersionConstraint) – Control Plane Apis version constraint for the API Management service.
restore (bool) – 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.
private_endpoint_connections (list[RemotePrivateEndpointConnectionWrapper]) – List of Private Endpoint Connections of this service.
publisher_email (str) – Publisher email. Required.
publisher_name (str) – Publisher name. Required.

class azure.mgmt.apimanagement.models.ApiManagementServiceSkuProperties(*, name: Union[str, _models.SkuType], capacity: int, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

API Management service resource SKU properties.

All required parameters must be populated in order to send to Azure.

Variables

name (str or SkuType) – Name of the Sku. Required. Known values are: “Developer”, “Standard”, “Premium”, “Basic”, “Consumption”, and “Isolated”.
capacity (int) – Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. Required.

Keyword Arguments

name (str or SkuType) – Name of the Sku. Required. Known values are: “Developer”, “Standard”, “Premium”, “Basic”, “Consumption”, and “Isolated”.
capacity (int) – Capacity of the SKU (number of deployed units of the SKU). For Consumption SKU capacity must be specified as 0. Required.

class azure.mgmt.apimanagement.models.ApiManagementServiceUpdateParameters(*, tags: Optional[Dict[str, str]] = None, sku: Optional[_models.ApiManagementServiceSkuProperties] = None, identity: Optional[_models.ApiManagementServiceIdentity] = None, zones: Optional[List[str]] = None, notification_sender_email: Optional[str] = None, hostname_configurations: Optional[List[_models.HostnameConfiguration]] = None, public_ip_address_id: Optional[str] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, virtual_network_configuration: Optional[_models.VirtualNetworkConfiguration] = None, additional_locations: Optional[List[_models.AdditionalLocation]] = None, custom_properties: Optional[Dict[str, str]] = None, certificates: Optional[List[_models.CertificateConfiguration]] = None, enable_client_certificate: bool = False, disable_gateway: bool = False, virtual_network_type: Union[str, _models.VirtualNetworkType] = 'None', api_version_constraint: Optional[_models.ApiVersionConstraint] = None, restore: bool = False, private_endpoint_connections: Optional[List[_models.RemotePrivateEndpointConnectionWrapper]] = None, publisher_email: Optional[str] = None, publisher_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.ApimResource

Parameter supplied to Update Api Management Service.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type for API Management resource is set to Microsoft.ApiManagement.
tags (dict[str, str]) – Resource tags.
sku (ApiManagementServiceSkuProperties) – SKU properties of the API Management service.
identity (ApiManagementServiceIdentity) – Managed service identity of the Api Management service.
etag (str) – ETag of the resource.
zones (list[str]) – A list of availability zones denoting where the resource needs to come from.
notification_sender_email (str) – Email address from which the notification will be sent.
provisioning_state (str) – 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.
target_provisioning_state (str) – The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
created_at_utc (datetime) – Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
gateway_url (str) – Gateway URL of the API Management service.
gateway_regional_url (str) – Gateway URL of the API Management service in the Default Region.
portal_url (str) – Publisher portal endpoint Url of the API Management service.
management_api_url (str) – Management API endpoint URL of the API Management service.
scm_url (str) – SCM endpoint URL of the API Management service.
developer_portal_url (str) – DEveloper Portal endpoint URL of the API Management service.
hostname_configurations (list[HostnameConfiguration]) – Custom hostname configuration of the API Management service.
public_ip_addresses (list[str]) – Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.
private_ip_addresses (list[str]) – 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.
public_ip_address_id (str) – 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.
public_network_access (str or 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’. Known values are: “Enabled” and “Disabled”.
virtual_network_configuration (VirtualNetworkConfiguration) – Virtual network configuration of the API Management service.
additional_locations (list[AdditionalLocation]) – Additional datacenter locations of the API Management service.
custom_properties (dict[str, str]) – Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties’ values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting’s default value is False.You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256: false. The default value is true for them. Note: next ciphers can’t be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384.
certificates (list[CertificateConfiguration]) – List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
enable_client_certificate (bool) – 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.
disable_gateway (bool) – Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
virtual_network_type (str or 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. Known values are: “None”, “External”, and “Internal”.
api_version_constraint (ApiVersionConstraint) – Control Plane Apis version constraint for the API Management service.
restore (bool) – 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.
private_endpoint_connections (list[RemotePrivateEndpointConnectionWrapper]) – List of Private Endpoint Connections of this service.
platform_version (str or PlatformVersion) – Compute Platform Version running the service in this location. Known values are: “undetermined”, “stv1”, “stv2”, and “mtv1”.
publisher_email (str) – Publisher email.
publisher_name (str) – Publisher name.

Keyword Arguments

tags (dict[str, str]) – Resource tags.
sku (ApiManagementServiceSkuProperties) – SKU properties of the API Management service.
identity (ApiManagementServiceIdentity) – Managed service identity of the Api Management service.
zones (list[str]) – A list of availability zones denoting where the resource needs to come from.
notification_sender_email (str) – Email address from which the notification will be sent.
hostname_configurations (list[HostnameConfiguration]) – Custom hostname configuration of the API Management service.
public_ip_address_id (str) – 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.
public_network_access (str or 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’. Known values are: “Enabled” and “Disabled”.
virtual_network_configuration (VirtualNetworkConfiguration) – Virtual network configuration of the API Management service.
additional_locations (list[AdditionalLocation]) – Additional datacenter locations of the API Management service.
custom_properties (dict[str, str]) – Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties’ values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting’s default value is False.You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256: false. The default value is true for them. Note: next ciphers can’t be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384.
certificates (list[CertificateConfiguration]) – List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
enable_client_certificate (bool) – 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.
disable_gateway (bool) – Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
virtual_network_type (str or 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. Known values are: “None”, “External”, and “Internal”.
api_version_constraint (ApiVersionConstraint) – Control Plane Apis version constraint for the API Management service.
restore (bool) – 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.
private_endpoint_connections (list[RemotePrivateEndpointConnectionWrapper]) – List of Private Endpoint Connections of this service.
publisher_email (str) – Publisher email.
publisher_name (str) – Publisher name.

class azure.mgmt.apimanagement.models.ApiManagementServiceUpdateProperties(*, notification_sender_email: Optional[str] = None, hostname_configurations: Optional[List[_models.HostnameConfiguration]] = None, public_ip_address_id: Optional[str] = None, public_network_access: Optional[Union[str, _models.PublicNetworkAccess]] = None, virtual_network_configuration: Optional[_models.VirtualNetworkConfiguration] = None, additional_locations: Optional[List[_models.AdditionalLocation]] = None, custom_properties: Optional[Dict[str, str]] = None, certificates: Optional[List[_models.CertificateConfiguration]] = None, enable_client_certificate: bool = False, disable_gateway: bool = False, virtual_network_type: Union[str, _models.VirtualNetworkType] = 'None', api_version_constraint: Optional[_models.ApiVersionConstraint] = None, restore: bool = False, private_endpoint_connections: Optional[List[_models.RemotePrivateEndpointConnectionWrapper]] = None, publisher_email: Optional[str] = None, publisher_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.ApiManagementServiceBaseProperties

Properties of an API Management service resource description.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

notification_sender_email (str) – Email address from which the notification will be sent.
provisioning_state (str) – 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.
target_provisioning_state (str) – The provisioning state of the API Management service, which is targeted by the long running operation started on the service.
created_at_utc (datetime) – Creation UTC date of the API Management service.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
gateway_url (str) – Gateway URL of the API Management service.
gateway_regional_url (str) – Gateway URL of the API Management service in the Default Region.
portal_url (str) – Publisher portal endpoint Url of the API Management service.
management_api_url (str) – Management API endpoint URL of the API Management service.
scm_url (str) – SCM endpoint URL of the API Management service.
developer_portal_url (str) – DEveloper Portal endpoint URL of the API Management service.
hostname_configurations (list[HostnameConfiguration]) – Custom hostname configuration of the API Management service.
public_ip_addresses (list[str]) – Public Static Load Balanced IP addresses of the API Management service in Primary region. Available only for Basic, Standard, Premium and Isolated SKU.
private_ip_addresses (list[str]) – 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.
public_ip_address_id (str) – 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.
public_network_access (str or 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’. Known values are: “Enabled” and “Disabled”.
virtual_network_configuration (VirtualNetworkConfiguration) – Virtual network configuration of the API Management service.
additional_locations (list[AdditionalLocation]) – Additional datacenter locations of the API Management service.
custom_properties (dict[str, str]) – Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties’ values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting’s default value is False.You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256: false. The default value is true for them. Note: next ciphers can’t be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384.
certificates (list[CertificateConfiguration]) – List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
enable_client_certificate (bool) – 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.
disable_gateway (bool) – Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
virtual_network_type (str or 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. Known values are: “None”, “External”, and “Internal”.
api_version_constraint (ApiVersionConstraint) – Control Plane Apis version constraint for the API Management service.
restore (bool) – 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.
private_endpoint_connections (list[RemotePrivateEndpointConnectionWrapper]) – List of Private Endpoint Connections of this service.
platform_version (str or PlatformVersion) – Compute Platform Version running the service in this location. Known values are: “undetermined”, “stv1”, “stv2”, and “mtv1”.
publisher_email (str) – Publisher email.
publisher_name (str) – Publisher name.

Keyword Arguments

notification_sender_email (str) – Email address from which the notification will be sent.
hostname_configurations (list[HostnameConfiguration]) – Custom hostname configuration of the API Management service.
public_ip_address_id (str) – 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.
public_network_access (str or 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’. Known values are: “Enabled” and “Disabled”.
virtual_network_configuration (VirtualNetworkConfiguration) – Virtual network configuration of the API Management service.
additional_locations (list[AdditionalLocation]) – Additional datacenter locations of the API Management service.
custom_properties (dict[str, str]) – Custom properties of the API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TripleDes168 will disable the cipher TLS_RSA_WITH_3DES_EDE_CBC_SHA for all TLS(1.0, 1.1 and 1.2).Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11 can be used to disable just TLS 1.1.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10 can be used to disable TLS 1.0 on an API Management service.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11 can be used to disable just TLS 1.1 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10 can be used to disable TLS 1.0 for communications with backends.Setting Microsoft.WindowsAzure.ApiManagement.Gateway.Protocols.Server.Http2 can be used to enable HTTP2 protocol on an API Management service.Not specifying any of these properties on PATCH operation will reset omitted properties’ values to their defaults. For all the settings except Http2 the default value is True if the service was created on or before April 1st 2018 and False otherwise. Http2 setting’s default value is False.You can disable any of next ciphers by using settings Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.[cipher_name]: TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA256, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA. For example, Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Ciphers.TLS_RSA_WITH_AES_128_CBC_SHA256: false. The default value is true for them. Note: next ciphers can’t be disabled since they are required by Azure CloudService internal components: TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_GCM_SHA384.
certificates (list[CertificateConfiguration]) – List of Certificates that need to be installed in the API Management service. Max supported certificates that can be installed is 10.
enable_client_certificate (bool) – 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.
disable_gateway (bool) – Property only valid for an Api Management service deployed in multiple locations. This can be used to disable the gateway in master region.
virtual_network_type (str or 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. Known values are: “None”, “External”, and “Internal”.
api_version_constraint (ApiVersionConstraint) – Control Plane Apis version constraint for the API Management service.
restore (bool) – 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.
private_endpoint_connections (list[RemotePrivateEndpointConnectionWrapper]) – List of Private Endpoint Connections of this service.
publisher_email (str) – Publisher email.
publisher_name (str) – Publisher name.

class azure.mgmt.apimanagement.models.ApiManagementSku(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Describes an available ApiManagement SKU.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

resource_type (str) – The type of resource the SKU applies to.
name (str) – The name of SKU.
tier (str) – Specifies the tier of virtual machines in a scale set.:code:   Possible Values:  Standard  Basic.
size (str) – The Size of the SKU.
family (str) – The Family of this particular SKU.
kind (str) – The Kind of resources that are supported in this SKU.
capacity (ApiManagementSkuCapacity) – Specifies the number of virtual machines in the scale set.
locations (list[str]) – The set of locations that the SKU is available.
location_info (list[ApiManagementSkuLocationInfo]) – A list of locations and availability zones in those locations where the SKU is available.
api_versions (list[str]) – The api versions that support this SKU.
costs (list[ApiManagementSkuCosts]) – Metadata for retrieving price info.
capabilities (list[ApiManagementSkuCapabilities]) – A name value pair to describe the capability.
restrictions (list[ApiManagementSkuRestrictions]) – The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.

class azure.mgmt.apimanagement.models.ApiManagementSkuCapabilities(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Describes The SKU capabilities object.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – An invariant to describe the feature.
value (str) – An invariant if the feature is measured by quantity.

class azure.mgmt.apimanagement.models.ApiManagementSkuCapacity(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Describes scaling information of a SKU.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

minimum (int) – The minimum capacity.
maximum (int) – The maximum capacity that can be set.
default (int) – The default capacity.
scale_type (str or ApiManagementSkuCapacityScaleType) – The scale type applicable to the sku. Known values are: “Automatic”, “Manual”, and “None”.

class azure.mgmt.apimanagement.models.ApiManagementSkuCapacityScaleType(value)[source]¶

Bases: str, enum.Enum

The scale type applicable to the sku.

AUTOMATIC = 'Automatic'¶

MANUAL = 'Manual'¶

NONE = 'None'¶

class azure.mgmt.apimanagement.models.ApiManagementSkuCosts(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Describes metadata for retrieving price info.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

meter_id (str) – Used for querying price from commerce.
quantity (int) – The multiplier is needed to extend the base metered cost.
extended_unit (str) – An invariant to show the extended unit.

class azure.mgmt.apimanagement.models.ApiManagementSkuLocationInfo(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

ApiManagementSkuLocationInfo.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

location (str) – Location of the SKU.
zones (list[str]) – List of availability zones where the SKU is supported.
zone_details (list[ApiManagementSkuZoneDetails]) – Details of capabilities available to a SKU in specific zones.

class azure.mgmt.apimanagement.models.ApiManagementSkuRestrictionInfo(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

ApiManagementSkuRestrictionInfo.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

locations (list[str]) – Locations where the SKU is restricted.
zones (list[str]) – List of availability zones where the SKU is restricted.

class azure.mgmt.apimanagement.models.ApiManagementSkuRestrictions(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Describes scaling information of a SKU.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

type (str or ApiManagementSkuRestrictionsType) – The type of restrictions. Known values are: “Location” and “Zone”.
values (list[str]) – The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted.
restriction_info (ApiManagementSkuRestrictionInfo) – The information about the restriction where the SKU cannot be used.
reason_code (str or ApiManagementSkuRestrictionsReasonCode) – The reason for restriction. Known values are: “QuotaId” and “NotAvailableForSubscription”.

class azure.mgmt.apimanagement.models.ApiManagementSkuRestrictionsReasonCode(value)[source]¶

Bases: str, enum.Enum

The reason for restriction.

NOT_AVAILABLE_FOR_SUBSCRIPTION = 'NotAvailableForSubscription'¶

QUOTA_ID = 'QuotaId'¶

class azure.mgmt.apimanagement.models.ApiManagementSkuRestrictionsType(value)[source]¶

Bases: str, enum.Enum

The type of restrictions.

LOCATION = 'Location'¶

ZONE = 'Zone'¶

class azure.mgmt.apimanagement.models.ApiManagementSkuZoneDetails(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Describes The zonal capabilities of a SKU.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (list[str]) – The set of zones that the SKU is available in with the specified capabilities.
capabilities (list[ApiManagementSkuCapabilities]) – A list of capabilities that are available for the SKU in the specified list of zones.

class azure.mgmt.apimanagement.models.ApiManagementSkusResult(*, value: List[_models.ApiManagementSku], **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

The List Resource Skus operation response.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

value (list[ApiManagementSku]) – The list of skus available for the subscription. Required.
next_link (str) – The URI to fetch the next page of Resource Skus. Call ListNext() with this URI to fetch the next page of Resource Skus.

Keyword Arguments

value (list[ApiManagementSku]) – The list of skus available for the subscription. Required.

class azure.mgmt.apimanagement.models.ApiReleaseCollection(*, count: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged ApiRelease list representation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ApiReleaseContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

count (int) – Total record count number across all pages.

class azure.mgmt.apimanagement.models.ApiReleaseContract(*, api_id: Optional[str] = None, notes: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

ApiRelease details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
api_id (str) – Identifier of the API the release belongs to.
created_date_time (datetime) – The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
updated_date_time (datetime) – The time the API release was updated.
notes (str) – Release Notes.

Keyword Arguments

api_id (str) – Identifier of the API the release belongs to.
notes (str) – Release Notes.

class azure.mgmt.apimanagement.models.ApiRevisionCollection(*, count: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged API Revision list representation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ApiRevisionContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

count (int) – Total record count number across all pages.

class azure.mgmt.apimanagement.models.ApiRevisionContract(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Summary of revision metadata.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

api_id (str) – Identifier of the API Revision.
api_revision (str) – Revision number of API.
created_date_time (datetime) – The time the API Revision was created. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
updated_date_time (datetime) – The time the API Revision were updated. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
description (str) – Description of the API Revision.
private_url (str) – Gateway URL for accessing the non-current API Revision.
is_online (bool) – Indicates if API revision is the current api revision.
is_current (bool) – Indicates if API revision is accessible via the gateway.

class azure.mgmt.apimanagement.models.ApiRevisionInfoContract(*, source_api_id: Optional[str] = None, api_version_name: Optional[str] = None, api_revision_description: Optional[str] = None, api_version_set: Optional[_models.ApiVersionSetContractDetails] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Object used to create an API Revision or Version based on an existing API Revision.

Variables

source_api_id (str) – Resource identifier of API to be used to create the revision from.
api_version_name (str) – Version identifier for the new API Version.
api_revision_description (str) – Description of new API Revision.
api_version_set (ApiVersionSetContractDetails) – Version set details.

Keyword Arguments

source_api_id (str) – Resource identifier of API to be used to create the revision from.
api_version_name (str) – Version identifier for the new API Version.
api_revision_description (str) – Description of new API Revision.
api_version_set (ApiVersionSetContractDetails) – Version set details.

class azure.mgmt.apimanagement.models.ApiTagResourceContractProperties(*, description: Optional[str] = None, authentication_settings: Optional[_models.AuthenticationSettingsContract] = None, subscription_key_parameter_names: Optional[_models.SubscriptionKeyParameterNamesContract] = None, api_type: Optional[Union[str, _models.ApiType]] = None, api_revision: Optional[str] = None, api_version: Optional[str] = None, is_current: Optional[bool] = None, api_revision_description: Optional[str] = None, api_version_description: Optional[str] = None, api_version_set_id: Optional[str] = None, subscription_required: Optional[bool] = None, terms_of_service_url: Optional[str] = None, contact: Optional[_models.ApiContactInformation] = None, license: Optional[_models.ApiLicenseInformation] = None, id: Optional[str] = None, name: Optional[str] = None, service_url: Optional[str] = None, path: Optional[str] = None, protocols: Optional[List[Union[str, _models.Protocol]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.ApiEntityBaseContract

API contract properties for the Tag Resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

description (str) – Description of the API. May include HTML formatting tags.
authentication_settings (AuthenticationSettingsContract) – Collection of authentication settings included into this API.
subscription_key_parameter_names (SubscriptionKeyParameterNamesContract) – Protocols over which API is made available.
api_type (str or ApiType) – Type of API. Known values are: “http”, “soap”, “websocket”, and “graphql”.
api_revision (str) – Describes the revision of the API. If no value is provided, default revision 1 is created.
api_version (str) – Indicates the version identifier of the API if the API is versioned.
is_current (bool) – Indicates if API revision is current api revision.
is_online (bool) – Indicates if API revision is accessible via the gateway.
api_revision_description (str) – Description of the API Revision.
api_version_description (str) – Description of the API Version.
api_version_set_id (str) – A resource identifier for the related ApiVersionSet.
subscription_required (bool) – Specifies whether an API or Product subscription is required for accessing the API.
terms_of_service_url (str) – A URL to the Terms of Service for the API. MUST be in the format of a URL.
contact (ApiContactInformation) – Contact information for the API.
license (ApiLicenseInformation) – License information for the API.
id (str) – API identifier in the form /apis/{apiId}.
name (str) – API name.
service_url (str) – Absolute URL of the backend service implementing this API.
path (str) – Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
protocols (list[str or Protocol]) – Describes on which protocols the operations in this API can be invoked.

Keyword Arguments

description (str) – Description of the API. May include HTML formatting tags.
authentication_settings (AuthenticationSettingsContract) – Collection of authentication settings included into this API.
subscription_key_parameter_names (SubscriptionKeyParameterNamesContract) – Protocols over which API is made available.
api_type (str or ApiType) – Type of API. Known values are: “http”, “soap”, “websocket”, and “graphql”.
api_revision (str) – Describes the revision of the API. If no value is provided, default revision 1 is created.
api_version (str) – Indicates the version identifier of the API if the API is versioned.
is_current (bool) – Indicates if API revision is current api revision.
api_revision_description (str) – Description of the API Revision.
api_version_description (str) – Description of the API Version.
api_version_set_id (str) – A resource identifier for the related ApiVersionSet.
subscription_required (bool) – Specifies whether an API or Product subscription is required for accessing the API.
terms_of_service_url (str) – A URL to the Terms of Service for the API. MUST be in the format of a URL.
contact (ApiContactInformation) – Contact information for the API.
license (ApiLicenseInformation) – License information for the API.
id (str) – API identifier in the form /apis/{apiId}.
name (str) – API name.
service_url (str) – Absolute URL of the backend service implementing this API.
path (str) – Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
protocols (list[str or Protocol]) – Describes on which protocols the operations in this API can be invoked.

class azure.mgmt.apimanagement.models.ApiType(value)[source]¶

Bases: str, enum.Enum

Type of API.

GRAPHQL = 'graphql'¶

HTTP = 'http'¶

SOAP = 'soap'¶

WEBSOCKET = 'websocket'¶

class azure.mgmt.apimanagement.models.ApiUpdateContract(*, description: Optional[str] = None, authentication_settings: Optional[_models.AuthenticationSettingsContract] = None, subscription_key_parameter_names: Optional[_models.SubscriptionKeyParameterNamesContract] = None, api_type: Optional[Union[str, _models.ApiType]] = None, api_revision: Optional[str] = None, api_version: Optional[str] = None, is_current: Optional[bool] = None, api_revision_description: Optional[str] = None, api_version_description: Optional[str] = None, api_version_set_id: Optional[str] = None, subscription_required: Optional[bool] = None, terms_of_service_url: Optional[str] = None, contact: Optional[_models.ApiContactInformation] = None, license: Optional[_models.ApiLicenseInformation] = None, display_name: Optional[str] = None, service_url: Optional[str] = None, path: Optional[str] = None, protocols: Optional[List[Union[str, _models.Protocol]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

API update contract details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

description (str) – Description of the API. May include HTML formatting tags.
authentication_settings (AuthenticationSettingsContract) – Collection of authentication settings included into this API.
subscription_key_parameter_names (SubscriptionKeyParameterNamesContract) – Protocols over which API is made available.
api_type (str or ApiType) – Type of API. Known values are: “http”, “soap”, “websocket”, and “graphql”.
api_revision (str) – Describes the revision of the API. If no value is provided, default revision 1 is created.
api_version (str) – Indicates the version identifier of the API if the API is versioned.
is_current (bool) – Indicates if API revision is current api revision.
is_online (bool) – Indicates if API revision is accessible via the gateway.
api_revision_description (str) – Description of the API Revision.
api_version_description (str) – Description of the API Version.
api_version_set_id (str) – A resource identifier for the related ApiVersionSet.
subscription_required (bool) – Specifies whether an API or Product subscription is required for accessing the API.
terms_of_service_url (str) – A URL to the Terms of Service for the API. MUST be in the format of a URL.
contact (ApiContactInformation) – Contact information for the API.
license (ApiLicenseInformation) – License information for the API.
display_name (str) – API name.
service_url (str) – Absolute URL of the backend service implementing this API.
path (str) – Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
protocols (list[str or Protocol]) – Describes on which protocols the operations in this API can be invoked.

Keyword Arguments

description (str) – Description of the API. May include HTML formatting tags.
authentication_settings (AuthenticationSettingsContract) – Collection of authentication settings included into this API.
subscription_key_parameter_names (SubscriptionKeyParameterNamesContract) – Protocols over which API is made available.
api_type (str or ApiType) – Type of API. Known values are: “http”, “soap”, “websocket”, and “graphql”.
api_revision (str) – Describes the revision of the API. If no value is provided, default revision 1 is created.
api_version (str) – Indicates the version identifier of the API if the API is versioned.
is_current (bool) – Indicates if API revision is current api revision.
api_revision_description (str) – Description of the API Revision.
api_version_description (str) – Description of the API Version.
api_version_set_id (str) – A resource identifier for the related ApiVersionSet.
subscription_required (bool) – Specifies whether an API or Product subscription is required for accessing the API.
terms_of_service_url (str) – A URL to the Terms of Service for the API. MUST be in the format of a URL.
contact (ApiContactInformation) – Contact information for the API.
license (ApiLicenseInformation) – License information for the API.
display_name (str) – API name.
service_url (str) – Absolute URL of the backend service implementing this API.
path (str) – Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
protocols (list[str or Protocol]) – Describes on which protocols the operations in this API can be invoked.

class azure.mgmt.apimanagement.models.ApiVersionConstraint(*, min_api_version: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Control Plane Apis version constraint for the API Management service.

Variables: min_api_version (str) – Limit control plane API calls to API Management service with version equal to or newer than this value.
Keyword Arguments: min_api_version (str) – Limit control plane API calls to API Management service with version equal to or newer than this value.

class azure.mgmt.apimanagement.models.ApiVersionSetCollection(*, value: Optional[List[_models.ApiVersionSetContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged API Version Set list representation.

Variables

value (list[ApiVersionSetContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[ApiVersionSetContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.ApiVersionSetContract(*, description: Optional[str] = None, version_query_name: Optional[str] = None, version_header_name: Optional[str] = None, display_name: Optional[str] = None, versioning_scheme: Optional[Union[str, _models.VersioningScheme]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

API Version Set Contract details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
description (str) – Description of API Version Set.
version_query_name (str) – Name of query parameter that indicates the API Version if versioningScheme is set to query.
version_header_name (str) – Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
display_name (str) – Name of API Version Set.
versioning_scheme (str or VersioningScheme) – An value that determines where the API Version identifier will be located in a HTTP request. Known values are: “Segment”, “Query”, and “Header”.

Keyword Arguments

description (str) – Description of API Version Set.
version_query_name (str) – Name of query parameter that indicates the API Version if versioningScheme is set to query.
version_header_name (str) – Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
display_name (str) – Name of API Version Set.
versioning_scheme (str or VersioningScheme) – An value that determines where the API Version identifier will be located in a HTTP request. Known values are: “Segment”, “Query”, and “Header”.

class azure.mgmt.apimanagement.models.ApiVersionSetContractDetails(*, id: Optional[str] = None, name: Optional[str] = None, description: Optional[str] = None, versioning_scheme: Optional[Union[str, _models.ApiVersionSetContractDetailsVersioningScheme]] = None, version_query_name: Optional[str] = None, version_header_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

An API Version Set contains the common configuration for a set of API Versions relating.

Variables

id (str) – Identifier for existing API Version Set. Omit this value to create a new Version Set.
name (str) – The display Name of the API Version Set.
description (str) – Description of API Version Set.
versioning_scheme (str or ApiVersionSetContractDetailsVersioningScheme) – An value that determines where the API Version identifier will be located in a HTTP request. Known values are: “Segment”, “Query”, and “Header”.
version_query_name (str) – Name of query parameter that indicates the API Version if versioningScheme is set to query.
version_header_name (str) – Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

Keyword Arguments

id (str) – Identifier for existing API Version Set. Omit this value to create a new Version Set.
name (str) – The display Name of the API Version Set.
description (str) – Description of API Version Set.
versioning_scheme (str or ApiVersionSetContractDetailsVersioningScheme) – An value that determines where the API Version identifier will be located in a HTTP request. Known values are: “Segment”, “Query”, and “Header”.
version_query_name (str) – Name of query parameter that indicates the API Version if versioningScheme is set to query.
version_header_name (str) – Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

class azure.mgmt.apimanagement.models.ApiVersionSetContractDetailsVersioningScheme(value)[source]¶

Bases: str, enum.Enum

An value that determines where the API Version identifier will be located in a HTTP request.

HEADER = 'Header'¶

QUERY = 'Query'¶

SEGMENT = 'Segment'¶

class azure.mgmt.apimanagement.models.ApiVersionSetContractProperties(*, display_name: str, versioning_scheme: Union[str, _models.VersioningScheme], description: Optional[str] = None, version_query_name: Optional[str] = None, version_header_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.ApiVersionSetEntityBase

Properties of an API Version Set.

All required parameters must be populated in order to send to Azure.

Variables

description (str) – Description of API Version Set.
version_query_name (str) – Name of query parameter that indicates the API Version if versioningScheme is set to query.
version_header_name (str) – Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
display_name (str) – Name of API Version Set. Required.
versioning_scheme (str or VersioningScheme) – An value that determines where the API Version identifier will be located in a HTTP request. Required. Known values are: “Segment”, “Query”, and “Header”.

Keyword Arguments

description (str) – Description of API Version Set.
version_query_name (str) – Name of query parameter that indicates the API Version if versioningScheme is set to query.
version_header_name (str) – Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
display_name (str) – Name of API Version Set. Required.
versioning_scheme (str or VersioningScheme) – An value that determines where the API Version identifier will be located in a HTTP request. Required. Known values are: “Segment”, “Query”, and “Header”.

class azure.mgmt.apimanagement.models.ApiVersionSetEntityBase(*, description: Optional[str] = None, version_query_name: Optional[str] = None, version_header_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

API Version set base parameters.

Variables

description (str) – Description of API Version Set.
version_query_name (str) – Name of query parameter that indicates the API Version if versioningScheme is set to query.
version_header_name (str) – Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

Keyword Arguments

description (str) – Description of API Version Set.
version_query_name (str) – Name of query parameter that indicates the API Version if versioningScheme is set to query.
version_header_name (str) – Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.

class azure.mgmt.apimanagement.models.ApiVersionSetUpdateParameters(*, description: Optional[str] = None, version_query_name: Optional[str] = None, version_header_name: Optional[str] = None, display_name: Optional[str] = None, versioning_scheme: Optional[Union[str, _models.VersioningScheme]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Parameters to update or create an API Version Set Contract.

Variables

description (str) – Description of API Version Set.
version_query_name (str) – Name of query parameter that indicates the API Version if versioningScheme is set to query.
version_header_name (str) – Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
display_name (str) – Name of API Version Set.
versioning_scheme (str or VersioningScheme) – An value that determines where the API Version identifier will be located in a HTTP request. Known values are: “Segment”, “Query”, and “Header”.

Keyword Arguments

description (str) – Description of API Version Set.
version_query_name (str) – Name of query parameter that indicates the API Version if versioningScheme is set to query.
version_header_name (str) – Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
display_name (str) – Name of API Version Set.
versioning_scheme (str or VersioningScheme) – An value that determines where the API Version identifier will be located in a HTTP request. Known values are: “Segment”, “Query”, and “Header”.

class azure.mgmt.apimanagement.models.ApiVersionSetUpdateParametersProperties(*, description: Optional[str] = None, version_query_name: Optional[str] = None, version_header_name: Optional[str] = None, display_name: Optional[str] = None, versioning_scheme: Optional[Union[str, _models.VersioningScheme]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.ApiVersionSetEntityBase

Properties used to create or update an API Version Set.

Variables

description (str) – Description of API Version Set.
version_query_name (str) – Name of query parameter that indicates the API Version if versioningScheme is set to query.
version_header_name (str) – Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
display_name (str) – Name of API Version Set.
versioning_scheme (str or VersioningScheme) – An value that determines where the API Version identifier will be located in a HTTP request. Known values are: “Segment”, “Query”, and “Header”.

Keyword Arguments

description (str) – Description of API Version Set.
version_query_name (str) – Name of query parameter that indicates the API Version if versioningScheme is set to query.
version_header_name (str) – Name of HTTP header parameter that indicates the API Version if versioningScheme is set to header.
display_name (str) – Name of API Version Set.
versioning_scheme (str or VersioningScheme) – An value that determines where the API Version identifier will be located in a HTTP request. Known values are: “Segment”, “Query”, and “Header”.

class azure.mgmt.apimanagement.models.ApimIdentityType(value)[source]¶

Bases: str, enum.Enum

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.

NONE = 'None'¶

SYSTEM_ASSIGNED = 'SystemAssigned'¶

SYSTEM_ASSIGNED_USER_ASSIGNED = 'SystemAssigned, UserAssigned'¶

USER_ASSIGNED = 'UserAssigned'¶

class azure.mgmt.apimanagement.models.ApimResource(*, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

The Resource definition.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Resource ID.
name (str) – Resource name.
type (str) – Resource type for API Management resource is set to Microsoft.ApiManagement.
tags (dict[str, str]) – Resource tags.

Keyword Arguments

tags (dict[str, str]) – Resource tags.

class azure.mgmt.apimanagement.models.AppType(value)[source]¶

Bases: str, enum.Enum

AppType.

DEVELOPER_PORTAL = 'developerPortal'¶: User create request was sent by new developer portal.

PORTAL = 'portal'¶: User create request was sent by legacy developer portal.

class azure.mgmt.apimanagement.models.ArmIdWrapper(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

A wrapper for an ARM resource id.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: id (str) –

class azure.mgmt.apimanagement.models.AssociationContract(*, provisioning_state: Optional[Literal[created]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Association entity details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
provisioning_state (str) – Provisioning state. Default value is “created”.

Keyword Arguments

provisioning_state (str) – Provisioning state. Default value is “created”.

class azure.mgmt.apimanagement.models.AsyncOperationStatus(value)[source]¶

Bases: str, enum.Enum

Status of an async operation.

FAILED = 'Failed'¶

IN_PROGRESS = 'InProgress'¶

STARTED = 'Started'¶

SUCCEEDED = 'Succeeded'¶

class azure.mgmt.apimanagement.models.AuthenticationSettingsContract(*, o_auth2: Optional[_models.OAuth2AuthenticationSettingsContract] = None, openid: Optional[_models.OpenIdAuthenticationSettingsContract] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

API Authentication Settings.

Variables

o_auth2 (OAuth2AuthenticationSettingsContract) – OAuth2 Authentication settings.
openid (OpenIdAuthenticationSettingsContract) – OpenID Connect Authentication Settings.

Keyword Arguments

o_auth2 (OAuth2AuthenticationSettingsContract) – OAuth2 Authentication settings.
openid (OpenIdAuthenticationSettingsContract) – OpenID Connect Authentication Settings.

class azure.mgmt.apimanagement.models.AuthorizationMethod(value)[source]¶

Bases: str, enum.Enum

AuthorizationMethod.

DELETE = 'DELETE'¶

GET = 'GET'¶

HEAD = 'HEAD'¶

OPTIONS = 'OPTIONS'¶

PATCH = 'PATCH'¶

POST = 'POST'¶

PUT = 'PUT'¶

TRACE = 'TRACE'¶

class azure.mgmt.apimanagement.models.AuthorizationServerCollection(*, value: Optional[List[_models.AuthorizationServerContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged OAuth2 Authorization Servers list representation.

Variables

value (list[AuthorizationServerContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[AuthorizationServerContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.AuthorizationServerContract(*, description: Optional[str] = None, authorization_methods: Optional[List[Union[str, _models.AuthorizationMethod]]] = None, client_authentication_method: Optional[List[Union[str, _models.ClientAuthenticationMethod]]] = None, token_body_parameters: Optional[List[_models.TokenBodyParameterContract]] = None, token_endpoint: Optional[str] = None, support_state: Optional[bool] = None, default_scope: Optional[str] = None, bearer_token_sending_methods: Optional[List[Union[str, _models.BearerTokenSendingMethod]]] = None, resource_owner_username: Optional[str] = None, resource_owner_password: Optional[str] = None, display_name: Optional[str] = None, client_registration_endpoint: Optional[str] = None, authorization_endpoint: Optional[str] = None, grant_types: Optional[List[Union[str, _models.GrantType]]] = None, client_id: Optional[str] = None, client_secret: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

External OAuth authorization server settings.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
description (str) – Description of the authorization server. Can contain HTML formatting tags.
authorization_methods (list[str or AuthorizationMethod]) – HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
client_authentication_method (list[str or ClientAuthenticationMethod]) – Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.
token_body_parameters (list[TokenBodyParameterContract]) – Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {“name” : “name value”, “value”: “a value”}.
token_endpoint (str) – OAuth token endpoint. Contains absolute URI to entity being referenced.
support_state (bool) – If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
default_scope (str) – Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.
bearer_token_sending_methods (list[str or BearerTokenSendingMethod]) – Specifies the mechanism by which access token is passed to the API.
resource_owner_username (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
resource_owner_password (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
display_name (str) – User-friendly authorization server name.
client_registration_endpoint (str) – Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
authorization_endpoint (str) – OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
grant_types (list[str or GrantType]) – Form of an authorization grant, which the client uses to request the access token.
client_id (str) – Client or app id registered with this authorization server.
client_secret (str) – Client or app secret registered with this authorization server. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.

Keyword Arguments

description (str) – Description of the authorization server. Can contain HTML formatting tags.
authorization_methods (list[str or AuthorizationMethod]) – HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
client_authentication_method (list[str or ClientAuthenticationMethod]) – Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.
token_body_parameters (list[TokenBodyParameterContract]) – Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {“name” : “name value”, “value”: “a value”}.
token_endpoint (str) – OAuth token endpoint. Contains absolute URI to entity being referenced.
support_state (bool) – If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
default_scope (str) – Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.
bearer_token_sending_methods (list[str or BearerTokenSendingMethod]) – Specifies the mechanism by which access token is passed to the API.
resource_owner_username (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
resource_owner_password (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
display_name (str) – User-friendly authorization server name.
client_registration_endpoint (str) – Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
authorization_endpoint (str) – OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
grant_types (list[str or GrantType]) – Form of an authorization grant, which the client uses to request the access token.
client_id (str) – Client or app id registered with this authorization server.
client_secret (str) – Client or app secret registered with this authorization server. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.

class azure.mgmt.apimanagement.models.AuthorizationServerContractBaseProperties(*, description: Optional[str] = None, authorization_methods: Optional[List[Union[str, _models.AuthorizationMethod]]] = None, client_authentication_method: Optional[List[Union[str, _models.ClientAuthenticationMethod]]] = None, token_body_parameters: Optional[List[_models.TokenBodyParameterContract]] = None, token_endpoint: Optional[str] = None, support_state: Optional[bool] = None, default_scope: Optional[str] = None, bearer_token_sending_methods: Optional[List[Union[str, _models.BearerTokenSendingMethod]]] = None, resource_owner_username: Optional[str] = None, resource_owner_password: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

External OAuth authorization server Update settings contract.

Variables

description (str) – Description of the authorization server. Can contain HTML formatting tags.
authorization_methods (list[str or AuthorizationMethod]) – HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
client_authentication_method (list[str or ClientAuthenticationMethod]) – Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.
token_body_parameters (list[TokenBodyParameterContract]) – Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {“name” : “name value”, “value”: “a value”}.
token_endpoint (str) – OAuth token endpoint. Contains absolute URI to entity being referenced.
support_state (bool) – If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
default_scope (str) – Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.
bearer_token_sending_methods (list[str or BearerTokenSendingMethod]) – Specifies the mechanism by which access token is passed to the API.
resource_owner_username (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
resource_owner_password (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.

Keyword Arguments

description (str) – Description of the authorization server. Can contain HTML formatting tags.
authorization_methods (list[str or AuthorizationMethod]) – HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
client_authentication_method (list[str or ClientAuthenticationMethod]) – Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.
token_body_parameters (list[TokenBodyParameterContract]) – Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {“name” : “name value”, “value”: “a value”}.
token_endpoint (str) – OAuth token endpoint. Contains absolute URI to entity being referenced.
support_state (bool) – If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
default_scope (str) – Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.
bearer_token_sending_methods (list[str or BearerTokenSendingMethod]) – Specifies the mechanism by which access token is passed to the API.
resource_owner_username (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
resource_owner_password (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.

class azure.mgmt.apimanagement.models.AuthorizationServerContractProperties(*, display_name: str, client_registration_endpoint: str, authorization_endpoint: str, grant_types: List[Union[str, _models.GrantType]], client_id: str, description: Optional[str] = None, authorization_methods: Optional[List[Union[str, _models.AuthorizationMethod]]] = None, client_authentication_method: Optional[List[Union[str, _models.ClientAuthenticationMethod]]] = None, token_body_parameters: Optional[List[_models.TokenBodyParameterContract]] = None, token_endpoint: Optional[str] = None, support_state: Optional[bool] = None, default_scope: Optional[str] = None, bearer_token_sending_methods: Optional[List[Union[str, _models.BearerTokenSendingMethod]]] = None, resource_owner_username: Optional[str] = None, resource_owner_password: Optional[str] = None, client_secret: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.AuthorizationServerContractBaseProperties

External OAuth authorization server settings Properties.

All required parameters must be populated in order to send to Azure.

Variables

description (str) – Description of the authorization server. Can contain HTML formatting tags.
authorization_methods (list[str or AuthorizationMethod]) – HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
client_authentication_method (list[str or ClientAuthenticationMethod]) – Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.
token_body_parameters (list[TokenBodyParameterContract]) – Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {“name” : “name value”, “value”: “a value”}.
token_endpoint (str) – OAuth token endpoint. Contains absolute URI to entity being referenced.
support_state (bool) – If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
default_scope (str) – Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.
bearer_token_sending_methods (list[str or BearerTokenSendingMethod]) – Specifies the mechanism by which access token is passed to the API.
resource_owner_username (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
resource_owner_password (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
display_name (str) – User-friendly authorization server name. Required.
client_registration_endpoint (str) – Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced. Required.
authorization_endpoint (str) – OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. Required.
grant_types (list[str or GrantType]) – Form of an authorization grant, which the client uses to request the access token. Required.
client_id (str) – Client or app id registered with this authorization server. Required.
client_secret (str) – Client or app secret registered with this authorization server. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.

Keyword Arguments

description (str) – Description of the authorization server. Can contain HTML formatting tags.
authorization_methods (list[str or AuthorizationMethod]) – HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
client_authentication_method (list[str or ClientAuthenticationMethod]) – Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.
token_body_parameters (list[TokenBodyParameterContract]) – Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {“name” : “name value”, “value”: “a value”}.
token_endpoint (str) – OAuth token endpoint. Contains absolute URI to entity being referenced.
support_state (bool) – If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
default_scope (str) – Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.
bearer_token_sending_methods (list[str or BearerTokenSendingMethod]) – Specifies the mechanism by which access token is passed to the API.
resource_owner_username (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
resource_owner_password (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
display_name (str) – User-friendly authorization server name. Required.
client_registration_endpoint (str) – Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced. Required.
authorization_endpoint (str) – OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. Required.
grant_types (list[str or GrantType]) – Form of an authorization grant, which the client uses to request the access token. Required.
client_id (str) – Client or app id registered with this authorization server. Required.
client_secret (str) – Client or app secret registered with this authorization server. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.

class azure.mgmt.apimanagement.models.AuthorizationServerSecretsContract(*, client_secret: Optional[str] = None, resource_owner_username: Optional[str] = None, resource_owner_password: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

OAuth Server Secrets Contract.

Variables

client_secret (str) – oAuth Authorization Server Secrets.
resource_owner_username (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
resource_owner_password (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.

Keyword Arguments

client_secret (str) – oAuth Authorization Server Secrets.
resource_owner_username (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
resource_owner_password (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.

class azure.mgmt.apimanagement.models.AuthorizationServerUpdateContract(*, description: Optional[str] = None, authorization_methods: Optional[List[Union[str, _models.AuthorizationMethod]]] = None, client_authentication_method: Optional[List[Union[str, _models.ClientAuthenticationMethod]]] = None, token_body_parameters: Optional[List[_models.TokenBodyParameterContract]] = None, token_endpoint: Optional[str] = None, support_state: Optional[bool] = None, default_scope: Optional[str] = None, bearer_token_sending_methods: Optional[List[Union[str, _models.BearerTokenSendingMethod]]] = None, resource_owner_username: Optional[str] = None, resource_owner_password: Optional[str] = None, display_name: Optional[str] = None, client_registration_endpoint: Optional[str] = None, authorization_endpoint: Optional[str] = None, grant_types: Optional[List[Union[str, _models.GrantType]]] = None, client_id: Optional[str] = None, client_secret: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

External OAuth authorization server settings.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
description (str) – Description of the authorization server. Can contain HTML formatting tags.
authorization_methods (list[str or AuthorizationMethod]) – HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
client_authentication_method (list[str or ClientAuthenticationMethod]) – Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.
token_body_parameters (list[TokenBodyParameterContract]) – Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {“name” : “name value”, “value”: “a value”}.
token_endpoint (str) – OAuth token endpoint. Contains absolute URI to entity being referenced.
support_state (bool) – If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
default_scope (str) – Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.
bearer_token_sending_methods (list[str or BearerTokenSendingMethod]) – Specifies the mechanism by which access token is passed to the API.
resource_owner_username (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
resource_owner_password (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
display_name (str) – User-friendly authorization server name.
client_registration_endpoint (str) – Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
authorization_endpoint (str) – OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
grant_types (list[str or GrantType]) – Form of an authorization grant, which the client uses to request the access token.
client_id (str) – Client or app id registered with this authorization server.
client_secret (str) – Client or app secret registered with this authorization server. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.

Keyword Arguments

description (str) – Description of the authorization server. Can contain HTML formatting tags.
authorization_methods (list[str or AuthorizationMethod]) – HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
client_authentication_method (list[str or ClientAuthenticationMethod]) – Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.
token_body_parameters (list[TokenBodyParameterContract]) – Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {“name” : “name value”, “value”: “a value”}.
token_endpoint (str) – OAuth token endpoint. Contains absolute URI to entity being referenced.
support_state (bool) – If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
default_scope (str) – Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.
bearer_token_sending_methods (list[str or BearerTokenSendingMethod]) – Specifies the mechanism by which access token is passed to the API.
resource_owner_username (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
resource_owner_password (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
display_name (str) – User-friendly authorization server name.
client_registration_endpoint (str) – Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
authorization_endpoint (str) – OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
grant_types (list[str or GrantType]) – Form of an authorization grant, which the client uses to request the access token.
client_id (str) – Client or app id registered with this authorization server.
client_secret (str) – Client or app secret registered with this authorization server. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.

class azure.mgmt.apimanagement.models.AuthorizationServerUpdateContractProperties(*, description: Optional[str] = None, authorization_methods: Optional[List[Union[str, _models.AuthorizationMethod]]] = None, client_authentication_method: Optional[List[Union[str, _models.ClientAuthenticationMethod]]] = None, token_body_parameters: Optional[List[_models.TokenBodyParameterContract]] = None, token_endpoint: Optional[str] = None, support_state: Optional[bool] = None, default_scope: Optional[str] = None, bearer_token_sending_methods: Optional[List[Union[str, _models.BearerTokenSendingMethod]]] = None, resource_owner_username: Optional[str] = None, resource_owner_password: Optional[str] = None, display_name: Optional[str] = None, client_registration_endpoint: Optional[str] = None, authorization_endpoint: Optional[str] = None, grant_types: Optional[List[Union[str, _models.GrantType]]] = None, client_id: Optional[str] = None, client_secret: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.AuthorizationServerContractBaseProperties

External OAuth authorization server Update settings contract.

Variables

description (str) – Description of the authorization server. Can contain HTML formatting tags.
authorization_methods (list[str or AuthorizationMethod]) – HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
client_authentication_method (list[str or ClientAuthenticationMethod]) – Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.
token_body_parameters (list[TokenBodyParameterContract]) – Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {“name” : “name value”, “value”: “a value”}.
token_endpoint (str) – OAuth token endpoint. Contains absolute URI to entity being referenced.
support_state (bool) – If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
default_scope (str) – Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.
bearer_token_sending_methods (list[str or BearerTokenSendingMethod]) – Specifies the mechanism by which access token is passed to the API.
resource_owner_username (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
resource_owner_password (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
display_name (str) – User-friendly authorization server name.
client_registration_endpoint (str) – Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
authorization_endpoint (str) – OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
grant_types (list[str or GrantType]) – Form of an authorization grant, which the client uses to request the access token.
client_id (str) – Client or app id registered with this authorization server.
client_secret (str) – Client or app secret registered with this authorization server. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.

Keyword Arguments

description (str) – Description of the authorization server. Can contain HTML formatting tags.
authorization_methods (list[str or AuthorizationMethod]) – HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
client_authentication_method (list[str or ClientAuthenticationMethod]) – Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.
token_body_parameters (list[TokenBodyParameterContract]) – Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {“name” : “name value”, “value”: “a value”}.
token_endpoint (str) – OAuth token endpoint. Contains absolute URI to entity being referenced.
support_state (bool) – If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
default_scope (str) – Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.
bearer_token_sending_methods (list[str or BearerTokenSendingMethod]) – Specifies the mechanism by which access token is passed to the API.
resource_owner_username (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
resource_owner_password (str) – Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
display_name (str) – User-friendly authorization server name.
client_registration_endpoint (str) – Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
authorization_endpoint (str) – OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
grant_types (list[str or GrantType]) – Form of an authorization grant, which the client uses to request the access token.
client_id (str) – Client or app id registered with this authorization server.
client_secret (str) – Client or app secret registered with this authorization server. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.

class azure.mgmt.apimanagement.models.BackendAuthorizationHeaderCredentials(*, scheme: str, parameter: str, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Authorization header information.

All required parameters must be populated in order to send to Azure.

Variables

scheme (str) – Authentication Scheme name. Required.
parameter (str) – Authentication Parameter value. Required.

Keyword Arguments

scheme (str) – Authentication Scheme name. Required.
parameter (str) – Authentication Parameter value. Required.

class azure.mgmt.apimanagement.models.BackendBaseParameters(*, title: Optional[str] = None, description: Optional[str] = None, resource_id: Optional[str] = None, properties: Optional[_models.BackendProperties] = None, credentials: Optional[_models.BackendCredentialsContract] = None, proxy: Optional[_models.BackendProxyContract] = None, tls: Optional[_models.BackendTlsProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Backend entity base Parameter set.

Variables

title (str) – Backend Title.
description (str) – Backend Description.
resource_id (str) – Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.
properties (BackendProperties) – Backend Properties contract.
credentials (BackendCredentialsContract) – Backend Credentials Contract Properties.
proxy (BackendProxyContract) – Backend Proxy Contract Properties.
tls (BackendTlsProperties) – Backend TLS Properties.

Keyword Arguments

title (str) – Backend Title.
description (str) – Backend Description.
resource_id (str) – Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.
properties (BackendProperties) – Backend Properties contract.
credentials (BackendCredentialsContract) – Backend Credentials Contract Properties.
proxy (BackendProxyContract) – Backend Proxy Contract Properties.
tls (BackendTlsProperties) – Backend TLS Properties.

class azure.mgmt.apimanagement.models.BackendCollection(*, value: Optional[List[_models.BackendContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Backend list representation.

Variables

value (list[BackendContract]) – Backend values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[BackendContract]) – Backend values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.BackendContract(*, title: Optional[str] = None, description: Optional[str] = None, resource_id: Optional[str] = None, properties: Optional[_models.BackendProperties] = None, credentials: Optional[_models.BackendCredentialsContract] = None, proxy: Optional[_models.BackendProxyContract] = None, tls: Optional[_models.BackendTlsProperties] = None, url: Optional[str] = None, protocol: Optional[Union[str, _models.BackendProtocol]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Backend details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
title (str) – Backend Title.
description (str) – Backend Description.
resource_id (str) – Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.
properties (BackendProperties) – Backend Properties contract.
credentials (BackendCredentialsContract) – Backend Credentials Contract Properties.
proxy (BackendProxyContract) – Backend Proxy Contract Properties.
tls (BackendTlsProperties) – Backend TLS Properties.
url (str) – Runtime Url of the Backend.
protocol (str or BackendProtocol) – Backend communication protocol. Known values are: “http” and “soap”.

Keyword Arguments

title (str) – Backend Title.
description (str) – Backend Description.
resource_id (str) – Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.
properties (BackendProperties) – Backend Properties contract.
credentials (BackendCredentialsContract) – Backend Credentials Contract Properties.
proxy (BackendProxyContract) – Backend Proxy Contract Properties.
tls (BackendTlsProperties) – Backend TLS Properties.
url (str) – Runtime Url of the Backend.
protocol (str or BackendProtocol) – Backend communication protocol. Known values are: “http” and “soap”.

class azure.mgmt.apimanagement.models.BackendContractProperties(*, url: str, protocol: Union[str, _models.BackendProtocol], title: Optional[str] = None, description: Optional[str] = None, resource_id: Optional[str] = None, properties: Optional[_models.BackendProperties] = None, credentials: Optional[_models.BackendCredentialsContract] = None, proxy: Optional[_models.BackendProxyContract] = None, tls: Optional[_models.BackendTlsProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.BackendBaseParameters

Parameters supplied to the Create Backend operation.

All required parameters must be populated in order to send to Azure.

Variables

title (str) – Backend Title.
description (str) – Backend Description.
resource_id (str) – Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.
properties (BackendProperties) – Backend Properties contract.
credentials (BackendCredentialsContract) – Backend Credentials Contract Properties.
proxy (BackendProxyContract) – Backend Proxy Contract Properties.
tls (BackendTlsProperties) – Backend TLS Properties.
url (str) – Runtime Url of the Backend. Required.
protocol (str or BackendProtocol) – Backend communication protocol. Required. Known values are: “http” and “soap”.

Keyword Arguments

title (str) – Backend Title.
description (str) – Backend Description.
resource_id (str) – Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.
properties (BackendProperties) – Backend Properties contract.
credentials (BackendCredentialsContract) – Backend Credentials Contract Properties.
proxy (BackendProxyContract) – Backend Proxy Contract Properties.
tls (BackendTlsProperties) – Backend TLS Properties.
url (str) – Runtime Url of the Backend. Required.
protocol (str or BackendProtocol) – Backend communication protocol. Required. Known values are: “http” and “soap”.

class azure.mgmt.apimanagement.models.BackendCredentialsContract(*, certificate_ids: Optional[List[str]] = None, certificate: Optional[List[str]] = None, query: Optional[Dict[str, List[str]]] = None, header: Optional[Dict[str, List[str]]] = None, authorization: Optional[_models.BackendAuthorizationHeaderCredentials] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Details of the Credentials used to connect to Backend.

Variables

certificate_ids (list[str]) – List of Client Certificate Ids.
certificate (list[str]) – List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
query (dict[str, list[str]]) – Query Parameter description.
header (dict[str, list[str]]) – Header Parameter description.
authorization (BackendAuthorizationHeaderCredentials) – Authorization header authentication.

Keyword Arguments

certificate_ids (list[str]) – List of Client Certificate Ids.
certificate (list[str]) – List of Client Certificate Thumbprints. Will be ignored if certificatesIds are provided.
query (dict[str, list[str]]) – Query Parameter description.
header (dict[str, list[str]]) – Header Parameter description.
authorization (BackendAuthorizationHeaderCredentials) – Authorization header authentication.

class azure.mgmt.apimanagement.models.BackendProperties(*, service_fabric_cluster: Optional[_models.BackendServiceFabricClusterProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Properties specific to the Backend Type.

Variables: service_fabric_cluster (BackendServiceFabricClusterProperties) – Backend Service Fabric Cluster Properties.
Keyword Arguments: service_fabric_cluster (BackendServiceFabricClusterProperties) – Backend Service Fabric Cluster Properties.

class azure.mgmt.apimanagement.models.BackendProtocol(value)[source]¶

Bases: str, enum.Enum

Backend communication protocol.

HTTP = 'http'¶: The Backend is a RESTful service.

SOAP = 'soap'¶: The Backend is a SOAP service.

class azure.mgmt.apimanagement.models.BackendProxyContract(*, url: str, username: Optional[str] = None, password: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Details of the Backend WebProxy Server to use in the Request to Backend.

All required parameters must be populated in order to send to Azure.

Variables

url (str) – WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. Required.
username (str) – Username to connect to the WebProxy server.
password (str) – Password to connect to the WebProxy Server.

Keyword Arguments

url (str) – WebProxy Server AbsoluteUri property which includes the entire URI stored in the Uri instance, including all fragments and query strings. Required.
username (str) – Username to connect to the WebProxy server.
password (str) – Password to connect to the WebProxy Server.

class azure.mgmt.apimanagement.models.BackendReconnectContract(*, after: Optional[datetime.timedelta] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Reconnect request parameters.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
after (timedelta) – Duration in ISO8601 format after which reconnect will be initiated. Minimum duration of the Reconnect is PT2M.

Keyword Arguments

after (timedelta) – Duration in ISO8601 format after which reconnect will be initiated. Minimum duration of the Reconnect is PT2M.

class azure.mgmt.apimanagement.models.BackendServiceFabricClusterProperties(*, management_endpoints: List[str], client_certificate_id: Optional[str] = None, client_certificatethumbprint: Optional[str] = None, max_partition_resolution_retries: Optional[int] = None, server_certificate_thumbprints: Optional[List[str]] = None, server_x509_names: Optional[List[_models.X509CertificateName]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Properties of the Service Fabric Type Backend.

All required parameters must be populated in order to send to Azure.

Variables

client_certificate_id (str) – The client certificate id for the management endpoint.
client_certificatethumbprint (str) – The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided.
max_partition_resolution_retries (int) – Maximum number of retries while attempting resolve the partition.
management_endpoints (list[str]) – The cluster management endpoint. Required.
server_certificate_thumbprints (list[str]) – Thumbprints of certificates cluster management service uses for tls communication.
server_x509_names (list[X509CertificateName]) – Server X509 Certificate Names Collection.

Keyword Arguments

client_certificate_id (str) – The client certificate id for the management endpoint.
client_certificatethumbprint (str) – The client certificate thumbprint for the management endpoint. Will be ignored if certificatesIds are provided.
max_partition_resolution_retries (int) – Maximum number of retries while attempting resolve the partition.
management_endpoints (list[str]) – The cluster management endpoint. Required.
server_certificate_thumbprints (list[str]) – Thumbprints of certificates cluster management service uses for tls communication.
server_x509_names (list[X509CertificateName]) – Server X509 Certificate Names Collection.

class azure.mgmt.apimanagement.models.BackendTlsProperties(*, validate_certificate_chain: bool = True, validate_certificate_name: bool = True, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Properties controlling TLS Certificate Validation.

Variables

validate_certificate_chain (bool) – Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
validate_certificate_name (bool) – Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.

Keyword Arguments

validate_certificate_chain (bool) – Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for this backend host.
validate_certificate_name (bool) – Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for this backend host.

class azure.mgmt.apimanagement.models.BackendUpdateParameterProperties(*, title: Optional[str] = None, description: Optional[str] = None, resource_id: Optional[str] = None, properties: Optional[_models.BackendProperties] = None, credentials: Optional[_models.BackendCredentialsContract] = None, proxy: Optional[_models.BackendProxyContract] = None, tls: Optional[_models.BackendTlsProperties] = None, url: Optional[str] = None, protocol: Optional[Union[str, _models.BackendProtocol]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.BackendBaseParameters

Parameters supplied to the Update Backend operation.

Variables

title (str) – Backend Title.
description (str) – Backend Description.
resource_id (str) – Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.
properties (BackendProperties) – Backend Properties contract.
credentials (BackendCredentialsContract) – Backend Credentials Contract Properties.
proxy (BackendProxyContract) – Backend Proxy Contract Properties.
tls (BackendTlsProperties) – Backend TLS Properties.
url (str) – Runtime Url of the Backend.
protocol (str or BackendProtocol) – Backend communication protocol. Known values are: “http” and “soap”.

Keyword Arguments

title (str) – Backend Title.
description (str) – Backend Description.
resource_id (str) – Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.
properties (BackendProperties) – Backend Properties contract.
credentials (BackendCredentialsContract) – Backend Credentials Contract Properties.
proxy (BackendProxyContract) – Backend Proxy Contract Properties.
tls (BackendTlsProperties) – Backend TLS Properties.
url (str) – Runtime Url of the Backend.
protocol (str or BackendProtocol) – Backend communication protocol. Known values are: “http” and “soap”.

class azure.mgmt.apimanagement.models.BackendUpdateParameters(*, title: Optional[str] = None, description: Optional[str] = None, resource_id: Optional[str] = None, properties: Optional[_models.BackendProperties] = None, credentials: Optional[_models.BackendCredentialsContract] = None, proxy: Optional[_models.BackendProxyContract] = None, tls: Optional[_models.BackendTlsProperties] = None, url: Optional[str] = None, protocol: Optional[Union[str, _models.BackendProtocol]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Backend update parameters.

Variables

title (str) – Backend Title.
description (str) – Backend Description.
resource_id (str) – Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.
properties (BackendProperties) – Backend Properties contract.
credentials (BackendCredentialsContract) – Backend Credentials Contract Properties.
proxy (BackendProxyContract) – Backend Proxy Contract Properties.
tls (BackendTlsProperties) – Backend TLS Properties.
url (str) – Runtime Url of the Backend.
protocol (str or BackendProtocol) – Backend communication protocol. Known values are: “http” and “soap”.

Keyword Arguments

title (str) – Backend Title.
description (str) – Backend Description.
resource_id (str) – Management Uri of the Resource in External System. This url can be the Arm Resource Id of Logic Apps, Function Apps or API Apps.
properties (BackendProperties) – Backend Properties contract.
credentials (BackendCredentialsContract) – Backend Credentials Contract Properties.
proxy (BackendProxyContract) – Backend Proxy Contract Properties.
tls (BackendTlsProperties) – Backend TLS Properties.
url (str) – Runtime Url of the Backend.
protocol (str or BackendProtocol) – Backend communication protocol. Known values are: “http” and “soap”.

class azure.mgmt.apimanagement.models.BearerTokenSendingMethod(value)[source]¶

Bases: str, enum.Enum

BearerTokenSendingMethod.

AUTHORIZATION_HEADER = 'authorizationHeader'¶

QUERY = 'query'¶

class azure.mgmt.apimanagement.models.BearerTokenSendingMethods(value)[source]¶

Bases: str, enum.Enum

Form of an authorization grant, which the client uses to request the access token.

AUTHORIZATION_HEADER = 'authorizationHeader'¶: Access token will be transmitted in the Authorization header using Bearer schema

QUERY = 'query'¶: Access token will be transmitted as query parameters.

class azure.mgmt.apimanagement.models.BodyDiagnosticSettings(*, bytes: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Body logging settings.

Variables: bytes (int) – Number of request body bytes to log.
Keyword Arguments: bytes (int) – Number of request body bytes to log.

class azure.mgmt.apimanagement.models.CacheCollection(*, value: Optional[List[_models.CacheContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Caches list representation.

Variables

value (list[CacheContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[CacheContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.CacheContract(*, description: Optional[str] = None, connection_string: Optional[str] = None, use_from_location: Optional[str] = None, resource_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Cache details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
description (str) – Cache description.
connection_string (str) – Runtime connection string to cache.
use_from_location (str) – Location identifier to use cache from (should be either ‘default’ or valid Azure region identifier).
resource_id (str) – Original uri of entity in external system cache points to.

Keyword Arguments

description (str) – Cache description.
connection_string (str) – Runtime connection string to cache.
use_from_location (str) – Location identifier to use cache from (should be either ‘default’ or valid Azure region identifier).
resource_id (str) – Original uri of entity in external system cache points to.

class azure.mgmt.apimanagement.models.CacheUpdateParameters(*, description: Optional[str] = None, connection_string: Optional[str] = None, use_from_location: Optional[str] = None, resource_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Cache update details.

Variables

description (str) – Cache description.
connection_string (str) – Runtime connection string to cache.
use_from_location (str) – Location identifier to use cache from (should be either ‘default’ or valid Azure region identifier).
resource_id (str) – Original uri of entity in external system cache points to.

Keyword Arguments

description (str) – Cache description.
connection_string (str) – Runtime connection string to cache.
use_from_location (str) – Location identifier to use cache from (should be either ‘default’ or valid Azure region identifier).
resource_id (str) – Original uri of entity in external system cache points to.

class azure.mgmt.apimanagement.models.CertificateCollection(*, value: Optional[List[_models.CertificateContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Certificates list representation.

Variables

value (list[CertificateContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[CertificateContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.CertificateConfiguration(*, store_name: Union[str, _models.CertificateConfigurationStoreName], encoded_certificate: Optional[str] = None, certificate_password: Optional[str] = None, certificate: Optional[_models.CertificateInformation] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Certificate configuration which consist of non-trusted intermediates and root certificates.

All required parameters must be populated in order to send to Azure.

Variables

encoded_certificate (str) – Base64 Encoded certificate.
certificate_password (str) – Certificate Password.
store_name (str or CertificateConfigurationStoreName) – The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. Required. Known values are: “CertificateAuthority” and “Root”.
certificate (CertificateInformation) – Certificate information.

Keyword Arguments

encoded_certificate (str) – Base64 Encoded certificate.
certificate_password (str) – Certificate Password.
store_name (str or CertificateConfigurationStoreName) – The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations. Required. Known values are: “CertificateAuthority” and “Root”.
certificate (CertificateInformation) – Certificate information.

class azure.mgmt.apimanagement.models.CertificateConfigurationStoreName(value)[source]¶

Bases: str, enum.Enum

The System.Security.Cryptography.x509certificates.StoreName certificate store location. Only Root and CertificateAuthority are valid locations.

CERTIFICATE_AUTHORITY = 'CertificateAuthority'¶

ROOT = 'Root'¶

class azure.mgmt.apimanagement.models.CertificateContract(*, subject: Optional[str] = None, thumbprint: Optional[str] = None, expiration_date: Optional[datetime.datetime] = None, key_vault: Optional[_models.KeyVaultContractProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Certificate details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
subject (str) – Subject attribute of the certificate.
thumbprint (str) – Thumbprint of the certificate.
expiration_date (datetime) – Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
key_vault (KeyVaultContractProperties) – KeyVault location details of the certificate.

Keyword Arguments

subject (str) – Subject attribute of the certificate.
thumbprint (str) – Thumbprint of the certificate.
expiration_date (datetime) – Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
key_vault (KeyVaultContractProperties) – KeyVault location details of the certificate.

class azure.mgmt.apimanagement.models.CertificateCreateOrUpdateParameters(*, data: Optional[str] = None, password: Optional[str] = None, key_vault: Optional[_models.KeyVaultContractCreateProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Certificate create or update details.

Variables

data (str) – Base 64 encoded certificate using the application/x-pkcs12 representation.
password (str) – Password for the Certificate.
key_vault (KeyVaultContractCreateProperties) – KeyVault location details of the certificate.

Keyword Arguments

data (str) – Base 64 encoded certificate using the application/x-pkcs12 representation.
password (str) – Password for the Certificate.
key_vault (KeyVaultContractCreateProperties) – KeyVault location details of the certificate.

class azure.mgmt.apimanagement.models.CertificateInformation(*, expiry: datetime.datetime, thumbprint: str, subject: str, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

SSL certificate information.

All required parameters must be populated in order to send to Azure.

Variables

expiry (datetime) – Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. Required.
thumbprint (str) – Thumbprint of the certificate. Required.
subject (str) – Subject of the certificate. Required.

Keyword Arguments

expiry (datetime) – Expiration date of the certificate. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. Required.
thumbprint (str) – Thumbprint of the certificate. Required.
subject (str) – Subject of the certificate. Required.

class azure.mgmt.apimanagement.models.CertificateSource(value)[source]¶

Bases: str, enum.Enum

Certificate Source.

BUILT_IN = 'BuiltIn'¶

CUSTOM = 'Custom'¶

KEY_VAULT = 'KeyVault'¶

MANAGED = 'Managed'¶

class azure.mgmt.apimanagement.models.CertificateStatus(value)[source]¶

Bases: str, enum.Enum

Certificate Status.

COMPLETED = 'Completed'¶

FAILED = 'Failed'¶

IN_PROGRESS = 'InProgress'¶

class azure.mgmt.apimanagement.models.ClientAuthenticationMethod(value)[source]¶

Bases: str, enum.Enum

ClientAuthenticationMethod.

BASIC = 'Basic'¶: Basic Client Authentication method.

BODY = 'Body'¶: Body based Authentication method.

class azure.mgmt.apimanagement.models.ClientSecretContract(*, client_secret: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.

Variables: client_secret (str) – Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.
Keyword Arguments: client_secret (str) – Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.

class azure.mgmt.apimanagement.models.ConfigurationIdName(value)[source]¶

Bases: str, enum.Enum

ConfigurationIdName.

CONFIGURATION = 'configuration'¶

class azure.mgmt.apimanagement.models.Confirmation(value)[source]¶

Bases: str, enum.Enum

Determines the type of confirmation e-mail that will be sent to the newly created user.

INVITE = 'invite'¶: Send an e-mail inviting the user to sign-up and complete registration.

SIGNUP = 'signup'¶: Send an e-mail to the user confirming they have successfully signed up.

class azure.mgmt.apimanagement.models.ConnectionStatus(value)[source]¶

Bases: str, enum.Enum

The connection status.

CONNECTED = 'Connected'¶

DEGRADED = 'Degraded'¶

DISCONNECTED = 'Disconnected'¶

UNKNOWN = 'Unknown'¶

class azure.mgmt.apimanagement.models.ConnectivityCheckProtocol(value)[source]¶

Bases: str, enum.Enum

The request’s protocol. Specific protocol configuration can be available based on this selection. The specified destination address must be coherent with this value.

HTTP = 'HTTP'¶

HTTPS = 'HTTPS'¶

TCP = 'TCP'¶

class azure.mgmt.apimanagement.models.ConnectivityCheckRequest(*, source: _models.ConnectivityCheckRequestSource, destination: _models.ConnectivityCheckRequestDestination, preferred_ip_version: Optional[Union[str, _models.PreferredIPVersion]] = None, protocol: Optional[Union[str, _models.ConnectivityCheckProtocol]] = None, protocol_configuration: Optional[_models.ConnectivityCheckRequestProtocolConfiguration] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

A request to perform the connectivity check operation on a API Management service.

All required parameters must be populated in order to send to Azure.

Variables

source (ConnectivityCheckRequestSource) – Definitions about the connectivity check origin. Required.
destination (ConnectivityCheckRequestDestination) – The connectivity check operation destination. Required.
preferred_ip_version (str or PreferredIPVersion) – The IP version to be used. Only IPv4 is supported for now. “IPv4”
protocol (str or ConnectivityCheckProtocol) – The request’s protocol. Specific protocol configuration can be available based on this selection. The specified destination address must be coherent with this value. Known values are: “TCP”, “HTTP”, and “HTTPS”.
protocol_configuration (ConnectivityCheckRequestProtocolConfiguration) – Protocol-specific configuration.

Keyword Arguments

source (ConnectivityCheckRequestSource) – Definitions about the connectivity check origin. Required.
destination (ConnectivityCheckRequestDestination) – The connectivity check operation destination. Required.
preferred_ip_version (str or PreferredIPVersion) – The IP version to be used. Only IPv4 is supported for now. “IPv4”
protocol (str or ConnectivityCheckProtocol) – The request’s protocol. Specific protocol configuration can be available based on this selection. The specified destination address must be coherent with this value. Known values are: “TCP”, “HTTP”, and “HTTPS”.
protocol_configuration (ConnectivityCheckRequestProtocolConfiguration) – Protocol-specific configuration.

class azure.mgmt.apimanagement.models.ConnectivityCheckRequestDestination(*, address: str, port: int, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

The connectivity check operation destination.

All required parameters must be populated in order to send to Azure.

Variables

address (str) – Destination address. Can either be an IP address or a FQDN. Required.
port (int) – Destination port. Required.

Keyword Arguments

address (str) – Destination address. Can either be an IP address or a FQDN. Required.
port (int) – Destination port. Required.

class azure.mgmt.apimanagement.models.ConnectivityCheckRequestProtocolConfiguration(*, http_configuration: Optional[_models.ConnectivityCheckRequestProtocolConfigurationHTTPConfiguration] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Protocol-specific configuration.

Variables: http_configuration (ConnectivityCheckRequestProtocolConfigurationHTTPConfiguration) – Configuration for HTTP or HTTPS requests.
Keyword Arguments: http_configuration (ConnectivityCheckRequestProtocolConfigurationHTTPConfiguration) – Configuration for HTTP or HTTPS requests.

class azure.mgmt.apimanagement.models.ConnectivityCheckRequestProtocolConfigurationHTTPConfiguration(*, method: Optional[Union[str, _models.Method]] = None, valid_status_codes: Optional[List[int]] = None, headers: Optional[List[_models.HTTPHeader]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Configuration for HTTP or HTTPS requests.

Variables

method (str or Method) – The HTTP method to be used. Known values are: “GET” and “POST”.
valid_status_codes (list[int]) – List of HTTP status codes considered valid for the request response.
headers (list[HTTPHeader]) – List of headers to be included in the request.

Keyword Arguments

method (str or Method) – The HTTP method to be used. Known values are: “GET” and “POST”.
valid_status_codes (list[int]) – List of HTTP status codes considered valid for the request response.
headers (list[HTTPHeader]) – List of headers to be included in the request.

class azure.mgmt.apimanagement.models.ConnectivityCheckRequestSource(*, region: str, instance: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Definitions about the connectivity check origin.

All required parameters must be populated in order to send to Azure.

Variables

region (str) – The API Management service region from where to start the connectivity check operation. Required.
instance (int) – The particular VMSS instance from which to fire the request.

Keyword Arguments

region (str) – The API Management service region from where to start the connectivity check operation. Required.
instance (int) – The particular VMSS instance from which to fire the request.

class azure.mgmt.apimanagement.models.ConnectivityCheckResponse(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Information on the connectivity status.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

hops (list[ConnectivityHop]) – List of hops between the source and the destination.
connection_status (str or ConnectionStatus) – The connection status. Known values are: “Unknown”, “Connected”, “Disconnected”, and “Degraded”.
avg_latency_in_ms (int) – Average latency in milliseconds.
min_latency_in_ms (int) – Minimum latency in milliseconds.
max_latency_in_ms (int) – Maximum latency in milliseconds.
probes_sent (int) – Total number of probes sent.
probes_failed (int) – Number of failed probes.

class azure.mgmt.apimanagement.models.ConnectivityHop(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Information about a hop between the source and the destination.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

type (str) – The type of the hop.
id (str) – The ID of the hop.
address (str) – The IP address of the hop.
resource_id (str) – The ID of the resource corresponding to this hop.
next_hop_ids (list[str]) – List of next hop identifiers.
issues (list[ConnectivityIssue]) – List of issues.

class azure.mgmt.apimanagement.models.ConnectivityIssue(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Information about an issue encountered in the process of checking for connectivity.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

origin (str or Origin) – The origin of the issue. Known values are: “Local”, “Inbound”, and “Outbound”.
severity (str or Severity) – The severity of the issue. Known values are: “Error” and “Warning”.
type (str or IssueType) – The type of issue. Known values are: “Unknown”, “AgentStopped”, “GuestFirewall”, “DnsResolution”, “SocketBind”, “NetworkSecurityRule”, “UserDefinedRoute”, “PortThrottled”, and “Platform”.
context (list[dict[str, str]]) – Provides additional context on the issue.

class azure.mgmt.apimanagement.models.ConnectivityStatusContract(*, name: str, status: Union[str, _models.ConnectivityStatusType], last_updated: datetime.datetime, last_status_change: datetime.datetime, resource_type: str, is_optional: bool, error: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Details about connectivity to a resource.

All required parameters must be populated in order to send to Azure.

Variables

name (str) – The hostname of the resource which the service depends on. This can be the database, storage or any other azure resource on which the service depends upon. Required.
status (str or ConnectivityStatusType) – Resource Connectivity Status Type identifier. Required. Known values are: “initializing”, “success”, and “failure”.
error (str) – Error details of the connectivity to the resource.
last_updated (datetime) – The date when the resource connectivity status was last updated. This status should be updated every 15 minutes. If this status has not been updated, then it means that the service has lost network connectivity to the resource, from inside the Virtual Network.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. Required.
last_status_change (datetime) – The date when the resource connectivity status last Changed from success to failure or vice-versa. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. Required.
resource_type (str) – Resource Type. Required.
is_optional (bool) – Whether this is optional. Required.

Keyword Arguments

name (str) – The hostname of the resource which the service depends on. This can be the database, storage or any other azure resource on which the service depends upon. Required.
status (str or ConnectivityStatusType) – Resource Connectivity Status Type identifier. Required. Known values are: “initializing”, “success”, and “failure”.
error (str) – Error details of the connectivity to the resource.
last_updated (datetime) – The date when the resource connectivity status was last updated. This status should be updated every 15 minutes. If this status has not been updated, then it means that the service has lost network connectivity to the resource, from inside the Virtual Network.The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. Required.
last_status_change (datetime) – The date when the resource connectivity status last Changed from success to failure or vice-versa. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. Required.
resource_type (str) – Resource Type. Required.
is_optional (bool) – Whether this is optional. Required.

class azure.mgmt.apimanagement.models.ConnectivityStatusType(value)[source]¶

Bases: str, enum.Enum

Resource Connectivity Status Type identifier.

FAILURE = 'failure'¶

INITIALIZING = 'initializing'¶

SUCCESS = 'success'¶

class azure.mgmt.apimanagement.models.ContentFormat(value)[source]¶

Bases: str, enum.Enum

Format of the Content in which the API is getting imported.

GRAPHQL_LINK = 'graphql-link'¶: The GraphQL API endpoint hosted on a publicly accessible internet address.

OPENAPI = 'openapi'¶: The contents are inline and Content Type is a OpenAPI 3.0 YAML Document.

OPENAPI_JSON = 'openapi+json'¶: The contents are inline and Content Type is a OpenAPI 3.0 JSON Document.

OPENAPI_JSON_LINK = 'openapi+json-link'¶: The OpenAPI 3.0 JSON document is hosted on a publicly accessible internet address.

OPENAPI_LINK = 'openapi-link'¶: The OpenAPI 3.0 YAML document is hosted on a publicly accessible internet address.

SWAGGER_JSON = 'swagger-json'¶: The contents are inline and Content Type is a OpenAPI 2.0 JSON Document.

SWAGGER_LINK_JSON = 'swagger-link-json'¶: The OpenAPI 2.0 JSON document is hosted on a publicly accessible internet address.

WADL_LINK_JSON = 'wadl-link-json'¶: The WADL document is hosted on a publicly accessible internet address.

WADL_XML = 'wadl-xml'¶: The contents are inline and Content type is a WADL document.

WSDL = 'wsdl'¶: The contents are inline and the document is a WSDL/Soap document.

WSDL_LINK = 'wsdl-link'¶: The WSDL document is hosted on a publicly accessible internet address.

class azure.mgmt.apimanagement.models.ContentItemCollection(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged list of content items.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ContentItemContract]) – Collection of content items.
next_link (str) – Next page link, if any.

class azure.mgmt.apimanagement.models.ContentItemContract(*, properties: Optional[Dict[str, Any]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Content type contract details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
properties (dict[str, any]) – Properties of the content item.

Keyword Arguments

properties (dict[str, any]) – Properties of the content item.

class azure.mgmt.apimanagement.models.ContentTypeCollection(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged list of content types.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[ContentTypeContract]) – Collection of content types.
next_link (str) – Next page link, if any.

class azure.mgmt.apimanagement.models.ContentTypeContract(*, id_properties_id: Optional[str] = None, name_properties_name: Optional[str] = None, description: Optional[str] = None, schema: Optional[collections.abc.MutableMapping[str, Any]] = None, version: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Content type contract details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
id_properties_id (str) – Content type identifier.
name_properties_name (str) – Content type name. Must be 1 to 250 characters long.
description (str) – Content type description.
schema (JSON) – Content type schema.
version (str) – Content type version.

Keyword Arguments

id_properties_id (str) – Content type identifier.
name_properties_name (str) – Content type name. Must be 1 to 250 characters long.
description (str) – Content type description.
schema (JSON) – Content type schema.
version (str) – Content type version.

class azure.mgmt.apimanagement.models.CreatedByType(value)[source]¶

Bases: str, enum.Enum

The type of identity that created the resource.

APPLICATION = 'Application'¶

KEY = 'Key'¶

MANAGED_IDENTITY = 'ManagedIdentity'¶

USER = 'User'¶

class azure.mgmt.apimanagement.models.DataMasking(*, query_params: Optional[List[_models.DataMaskingEntity]] = None, headers: Optional[List[_models.DataMaskingEntity]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

DataMasking.

Variables

query_params (list[DataMaskingEntity]) – Masking settings for Url query parameters.
headers (list[DataMaskingEntity]) – Masking settings for headers.

Keyword Arguments

query_params (list[DataMaskingEntity]) – Masking settings for Url query parameters.
headers (list[DataMaskingEntity]) – Masking settings for headers.

class azure.mgmt.apimanagement.models.DataMaskingEntity(*, value: Optional[str] = None, mode: Optional[Union[str, _models.DataMaskingMode]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

DataMaskingEntity.

Variables

value (str) – The name of an entity to mask (e.g. a name of a header or a query parameter).
mode (str or DataMaskingMode) – Data masking mode. Known values are: “Mask” and “Hide”.

Keyword Arguments

value (str) – The name of an entity to mask (e.g. a name of a header or a query parameter).
mode (str or DataMaskingMode) – Data masking mode. Known values are: “Mask” and “Hide”.

class azure.mgmt.apimanagement.models.DataMaskingMode(value)[source]¶

Bases: str, enum.Enum

Data masking mode.

HIDE = 'Hide'¶: Hide the presence of an entity.

MASK = 'Mask'¶: Mask the value of an entity.

class azure.mgmt.apimanagement.models.DeletedServiceContract(*, service_id: Optional[str] = None, scheduled_purge_date: Optional[datetime.datetime] = None, deletion_date: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Deleted API Management Service information.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
location (str) – API Management Service Master Location.
service_id (str) – Fully-qualified API Management Service Resource ID.
scheduled_purge_date (datetime) – UTC Date and Time when the service will be automatically purged. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
deletion_date (datetime) – UTC Timestamp when the service was soft-deleted. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Keyword Arguments

service_id (str) – Fully-qualified API Management Service Resource ID.
scheduled_purge_date (datetime) – UTC Date and Time when the service will be automatically purged. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
deletion_date (datetime) – UTC Timestamp when the service was soft-deleted. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

class azure.mgmt.apimanagement.models.DeletedServicesCollection(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged deleted API Management Services List Representation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[DeletedServiceContract]) – Page values.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.DeployConfigurationParameters(*, branch: Optional[str] = None, force: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Deploy Tenant Configuration Contract.

Variables

branch (str) – The name of the Git branch from which the configuration is to be deployed to the configuration database.
force (bool) – The value enforcing deleting subscriptions to products that are deleted in this update.

Keyword Arguments

branch (str) – The name of the Git branch from which the configuration is to be deployed to the configuration database.
force (bool) – The value enforcing deleting subscriptions to products that are deleted in this update.

class azure.mgmt.apimanagement.models.DiagnosticCollection(*, value: Optional[List[_models.DiagnosticContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Diagnostic list representation.

Variables

value (list[DiagnosticContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[DiagnosticContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.DiagnosticContract(*, always_log: Optional[Union[str, _models.AlwaysLog]] = None, logger_id: Optional[str] = None, sampling: Optional[_models.SamplingSettings] = None, frontend: Optional[_models.PipelineDiagnosticSettings] = None, backend: Optional[_models.PipelineDiagnosticSettings] = None, log_client_ip: Optional[bool] = None, http_correlation_protocol: Optional[Union[str, _models.HttpCorrelationProtocol]] = None, verbosity: Optional[Union[str, _models.Verbosity]] = None, operation_name_format: Optional[Union[str, _models.OperationNameFormat]] = None, metrics: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Diagnostic details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
always_log (str or AlwaysLog) – Specifies for what type of messages sampling settings should not apply. “allErrors”
logger_id (str) – Resource Id of a target logger.
sampling (SamplingSettings) – Sampling settings for Diagnostic.
frontend (PipelineDiagnosticSettings) – Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
backend (PipelineDiagnosticSettings) – Diagnostic settings for incoming/outgoing HTTP messages to the Backend.
log_client_ip (bool) – Log the ClientIP. Default is false.
http_correlation_protocol (str or HttpCorrelationProtocol) – Sets correlation protocol to use for Application Insights diagnostics. Known values are: “None”, “Legacy”, and “W3C”.
verbosity (str or Verbosity) – The verbosity level applied to traces emitted by trace policies. Known values are: “verbose”, “information”, and “error”.
operation_name_format (str or OperationNameFormat) – The format of the Operation Name for Application Insights telemetries. Default is Name. Known values are: “Name” and “Url”.
metrics (bool) – Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.

Keyword Arguments

always_log (str or AlwaysLog) – Specifies for what type of messages sampling settings should not apply. “allErrors”
logger_id (str) – Resource Id of a target logger.
sampling (SamplingSettings) – Sampling settings for Diagnostic.
frontend (PipelineDiagnosticSettings) – Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
backend (PipelineDiagnosticSettings) – Diagnostic settings for incoming/outgoing HTTP messages to the Backend.
log_client_ip (bool) – Log the ClientIP. Default is false.
http_correlation_protocol (str or HttpCorrelationProtocol) – Sets correlation protocol to use for Application Insights diagnostics. Known values are: “None”, “Legacy”, and “W3C”.
verbosity (str or Verbosity) – The verbosity level applied to traces emitted by trace policies. Known values are: “verbose”, “information”, and “error”.
operation_name_format (str or OperationNameFormat) – The format of the Operation Name for Application Insights telemetries. Default is Name. Known values are: “Name” and “Url”.
metrics (bool) – Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.

class azure.mgmt.apimanagement.models.EmailTemplateCollection(*, value: Optional[List[_models.EmailTemplateContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged email template list representation.

Variables

value (list[EmailTemplateContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[EmailTemplateContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.EmailTemplateContract(*, subject: Optional[str] = None, body: Optional[str] = None, title: Optional[str] = None, description: Optional[str] = None, parameters: Optional[List[_models.EmailTemplateParametersContractProperties]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Email Template details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
subject (str) – Subject of the Template.
body (str) – Email Template Body. This should be a valid XDocument.
title (str) – Title of the Template.
description (str) – Description of the Email Template.
is_default (bool) – Whether the template is the default template provided by API Management or has been edited.
parameters (list[EmailTemplateParametersContractProperties]) – Email Template Parameter values.

Keyword Arguments

subject (str) – Subject of the Template.
body (str) – Email Template Body. This should be a valid XDocument.
title (str) – Title of the Template.
description (str) – Description of the Email Template.
parameters (list[EmailTemplateParametersContractProperties]) – Email Template Parameter values.

class azure.mgmt.apimanagement.models.EmailTemplateParametersContractProperties(*, name: Optional[str] = None, title: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Email Template Parameter contract.

Variables

name (str) – Template parameter name.
title (str) – Template parameter title.
description (str) – Template parameter description.

Keyword Arguments

name (str) – Template parameter name.
title (str) – Template parameter title.
description (str) – Template parameter description.

class azure.mgmt.apimanagement.models.EmailTemplateUpdateParameters(*, subject: Optional[str] = None, title: Optional[str] = None, description: Optional[str] = None, body: Optional[str] = None, parameters: Optional[List[_models.EmailTemplateParametersContractProperties]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Email Template update Parameters.

Variables

subject (str) – Subject of the Template.
title (str) – Title of the Template.
description (str) – Description of the Email Template.
body (str) – Email Template Body. This should be a valid XDocument.
parameters (list[EmailTemplateParametersContractProperties]) – Email Template Parameter values.

Keyword Arguments

subject (str) – Subject of the Template.
title (str) – Title of the Template.
description (str) – Description of the Email Template.
body (str) – Email Template Body. This should be a valid XDocument.
parameters (list[EmailTemplateParametersContractProperties]) – Email Template Parameter values.

class azure.mgmt.apimanagement.models.EndpointDependency(*, domain_name: Optional[str] = None, endpoint_details: Optional[List[_models.EndpointDetail]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

A domain name that a service is reached at.

Variables

domain_name (str) – The domain name of the dependency.
endpoint_details (list[EndpointDetail]) – The Ports used when connecting to DomainName.

Keyword Arguments

domain_name (str) – The domain name of the dependency.
endpoint_details (list[EndpointDetail]) – The Ports used when connecting to DomainName.

class azure.mgmt.apimanagement.models.EndpointDetail(*, port: Optional[int] = None, region: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Current TCP connectivity information from the Api Management Service to a single endpoint.

Variables

port (int) – The port an endpoint is connected to.
region (str) – The region of the dependency.

Keyword Arguments

port (int) – The port an endpoint is connected to.
region (str) – The region of the dependency.

class azure.mgmt.apimanagement.models.ErrorFieldContract(*, code: Optional[str] = None, message: Optional[str] = None, target: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Error Field contract.

Variables

code (str) – Property level error code.
message (str) – Human-readable representation of property-level error.
target (str) – Property name.

Keyword Arguments

code (str) – Property level error code.
message (str) – Human-readable representation of property-level error.
target (str) – Property name.

class azure.mgmt.apimanagement.models.ErrorResponse(*, code: Optional[str] = None, message: Optional[str] = None, details: Optional[List[_models.ErrorFieldContract]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Error Response.

Variables

code (str) – Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
message (str) – Human-readable representation of the error.
details (list[ErrorFieldContract]) – The list of invalid fields send in request, in case of validation error.

Keyword Arguments

code (str) – Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
message (str) – Human-readable representation of the error.
details (list[ErrorFieldContract]) – The list of invalid fields send in request, in case of validation error.

class azure.mgmt.apimanagement.models.ErrorResponseBody(*, code: Optional[str] = None, message: Optional[str] = None, details: Optional[List[_models.ErrorFieldContract]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Error Body contract.

Variables

code (str) – Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
message (str) – Human-readable representation of the error.
details (list[ErrorFieldContract]) – The list of invalid fields send in request, in case of validation error.

Keyword Arguments

code (str) – Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.
message (str) – Human-readable representation of the error.
details (list[ErrorFieldContract]) – The list of invalid fields send in request, in case of validation error.

class azure.mgmt.apimanagement.models.ExportApi(value)[source]¶

Bases: str, enum.Enum

ExportApi.

TRUE = 'true'¶

class azure.mgmt.apimanagement.models.ExportFormat(value)[source]¶

Bases: str, enum.Enum

ExportFormat.

OPENAPI = 'openapi-link'¶: Export the Api Definition in OpenAPI 3.0 Specification as YAML document to Storage Blob.

OPENAPI_JSON = 'openapi+json-link'¶: Export the Api Definition in OpenAPI 3.0 Specification as JSON document to Storage Blob.

SWAGGER = 'swagger-link'¶: Export the Api Definition in OpenAPI 2.0 Specification as JSON document to the Storage Blob.

WADL = 'wadl-link'¶: Export the Api Definition in WADL Schema to Storage Blob.

WSDL = 'wsdl-link'¶: Export the Api Definition in WSDL Schema to Storage Blob. This is only supported for APIs of Type soap

class azure.mgmt.apimanagement.models.ExportResultFormat(value)[source]¶

Bases: str, enum.Enum

Format in which the API Details are exported to the Storage Blob with Sas Key valid for 5 minutes.

OPEN_API = 'openapi-link'¶: Export the API Definition in OpenAPI Specification 3.0 to Storage Blob.

SWAGGER = 'swagger-link-json'¶: The API Definition is exported in OpenAPI Specification 2.0 format to the Storage Blob.

WADL = 'wadl-link-json'¶: Export the API Definition in WADL Schema to Storage Blob.

WSDL = 'wsdl-link+xml'¶: The API Definition is exported in WSDL Schema to Storage Blob. This is only supported for APIs of Type soap

class azure.mgmt.apimanagement.models.GatewayCertificateAuthorityCollection(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Gateway certificate authority list representation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[GatewayCertificateAuthorityContract]) – Page values.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.GatewayCertificateAuthorityContract(*, is_trusted: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Gateway certificate authority details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
is_trusted (bool) – Determines whether certificate authority is trusted.

Keyword Arguments

is_trusted (bool) – Determines whether certificate authority is trusted.

class azure.mgmt.apimanagement.models.GatewayCollection(*, count: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Gateway list representation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[GatewayContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

count (int) – Total record count number across all pages.

class azure.mgmt.apimanagement.models.GatewayContract(*, location_data: Optional[_models.ResourceLocationDataContract] = None, description: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Gateway details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
location_data (ResourceLocationDataContract) – Gateway location.
description (str) – Gateway description.

Keyword Arguments

location_data (ResourceLocationDataContract) – Gateway location.
description (str) – Gateway description.

class azure.mgmt.apimanagement.models.GatewayHostnameConfigurationCollection(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Gateway hostname configuration list representation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[GatewayHostnameConfigurationContract]) – Page values.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.GatewayHostnameConfigurationContract(*, hostname: Optional[str] = None, certificate_id: Optional[str] = None, negotiate_client_certificate: Optional[bool] = None, tls10_enabled: Optional[bool] = None, tls11_enabled: Optional[bool] = None, http2_enabled: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Gateway hostname configuration details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
hostname (str) – Hostname value. Supports valid domain name, partial or full wildcard.
certificate_id (str) – Identifier of Certificate entity that will be used for TLS connection establishment.
negotiate_client_certificate (bool) – Determines whether gateway requests client certificate.
tls10_enabled (bool) – Specifies if TLS 1.0 is supported.
tls11_enabled (bool) – Specifies if TLS 1.1 is supported.
http2_enabled (bool) – Specifies if HTTP/2.0 is supported.

Keyword Arguments

hostname (str) – Hostname value. Supports valid domain name, partial or full wildcard.
certificate_id (str) – Identifier of Certificate entity that will be used for TLS connection establishment.
negotiate_client_certificate (bool) – Determines whether gateway requests client certificate.
tls10_enabled (bool) – Specifies if TLS 1.0 is supported.
tls11_enabled (bool) – Specifies if TLS 1.1 is supported.
http2_enabled (bool) – Specifies if HTTP/2.0 is supported.

class azure.mgmt.apimanagement.models.GatewayKeyRegenerationRequestContract(*, key_type: Union[str, _models.KeyType], **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Gateway key regeneration request contract properties.

All required parameters must be populated in order to send to Azure.

Variables: key_type (str or KeyType) – The Key being regenerated. Required. Known values are: “primary” and “secondary”.
Keyword Arguments: key_type (str or KeyType) – The Key being regenerated. Required. Known values are: “primary” and “secondary”.

class azure.mgmt.apimanagement.models.GatewayKeysContract(*, primary: Optional[str] = None, secondary: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Gateway authentication keys.

Variables

primary (str) – Primary gateway key.
secondary (str) – Secondary gateway key.

Keyword Arguments

primary (str) – Primary gateway key.
secondary (str) – Secondary gateway key.

class azure.mgmt.apimanagement.models.GatewayTokenContract(*, value: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Gateway access token.

Variables: value (str) – Shared Access Authentication token value for the Gateway.
Keyword Arguments: value (str) – Shared Access Authentication token value for the Gateway.

class azure.mgmt.apimanagement.models.GatewayTokenRequestContract(*, key_type: Union[str, _models.KeyType], expiry: datetime.datetime, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Gateway token request contract properties.

All required parameters must be populated in order to send to Azure.

Variables

key_type (str or KeyType) – The Key to be used to generate gateway token. Required. Known values are: “primary” and “secondary”.
expiry (datetime) – The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. Required.

Keyword Arguments

key_type (str or KeyType) – The Key to be used to generate gateway token. Required. Known values are: “primary” and “secondary”.
expiry (datetime) – The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. Required.

class azure.mgmt.apimanagement.models.GenerateSsoUrlResult(*, value: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Generate SSO Url operations response details.

Variables: value (str) – Redirect Url containing the SSO URL value.
Keyword Arguments: value (str) – Redirect Url containing the SSO URL value.

class azure.mgmt.apimanagement.models.GlobalSchemaCollection(*, count: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

The response of the list schema operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[GlobalSchemaContract]) – Global Schema Contract value.
count (int) – Total record count number.
next_link (str) – Next page link if any.

Keyword Arguments

count (int) – Total record count number.

class azure.mgmt.apimanagement.models.GlobalSchemaContract(*, schema_type: Optional[Union[str, _models.SchemaType]] = None, description: Optional[str] = None, value: Optional[Any] = None, document: Optional[collections.abc.MutableMapping[str, Any]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Global Schema Contract details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
schema_type (str or SchemaType) – Schema Type. Immutable. Known values are: “xml” and “json”.
description (str) – Free-form schema entity description.
value (any) – Json-encoded string for non json-based schema.
document (JSON) – Global Schema document object for json-based schema formats(e.g. json schema).

Keyword Arguments

schema_type (str or SchemaType) – Schema Type. Immutable. Known values are: “xml” and “json”.
description (str) – Free-form schema entity description.
value (any) – Json-encoded string for non json-based schema.
document (JSON) – Global Schema document object for json-based schema formats(e.g. json schema).

class azure.mgmt.apimanagement.models.GrantType(value)[source]¶

Bases: str, enum.Enum

GrantType.

AUTHORIZATION_CODE = 'authorizationCode'¶

//tools.ietf.org/html/rfc6749#section-4.1.

Type: Authorization Code Grant flow as described https

CLIENT_CREDENTIALS = 'clientCredentials'¶

//tools.ietf.org/html/rfc6749#section-4.4.

Type: Client Credentials Grant flow as described https

IMPLICIT = 'implicit'¶

//tools.ietf.org/html/rfc6749#section-4.2.

Type: Implicit Code Grant flow as described https

RESOURCE_OWNER_PASSWORD = 'resourceOwnerPassword'¶: Resource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3.

class azure.mgmt.apimanagement.models.GroupCollection(*, value: Optional[List[_models.GroupContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Group list representation.

Variables

value (list[GroupContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[GroupContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.GroupContract(*, display_name: Optional[str] = None, description: Optional[str] = None, type_properties_type: Optional[Union[str, _models.GroupType]] = None, external_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Contract details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
display_name (str) – Group name.
description (str) – Group description. Can contain HTML formatting tags.
built_in (bool) – true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
type_properties_type (str or GroupType) – Group type. Known values are: “custom”, “system”, and “external”.
external_id (str) – For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

Keyword Arguments

display_name (str) – Group name.
description (str) – Group description. Can contain HTML formatting tags.
type_properties_type (str or GroupType) – Group type. Known values are: “custom”, “system”, and “external”.
external_id (str) – For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

class azure.mgmt.apimanagement.models.GroupContractProperties(*, display_name: str, description: Optional[str] = None, type: Optional[Union[str, _models.GroupType]] = None, external_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Group contract Properties.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

display_name (str) – Group name. Required.
description (str) – Group description. Can contain HTML formatting tags.
built_in (bool) – true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false.
type (str or GroupType) – Group type. Known values are: “custom”, “system”, and “external”.
external_id (str) – For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

Keyword Arguments

display_name (str) – Group name. Required.
description (str) – Group description. Can contain HTML formatting tags.
type (str or GroupType) – Group type. Known values are: “custom”, “system”, and “external”.
external_id (str) – For external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

class azure.mgmt.apimanagement.models.GroupCreateParameters(*, display_name: Optional[str] = None, description: Optional[str] = None, type: Optional[Union[str, _models.GroupType]] = None, external_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Parameters supplied to the Create Group operation.

Variables

display_name (str) – Group name.
description (str) – Group description.
type (str or GroupType) – Group type. Known values are: “custom”, “system”, and “external”.
external_id (str) – Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

Keyword Arguments

display_name (str) – Group name.
description (str) – Group description.
type (str or GroupType) – Group type. Known values are: “custom”, “system”, and “external”.
external_id (str) – Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

class azure.mgmt.apimanagement.models.GroupType(value)[source]¶

Bases: str, enum.Enum

Group type.

CUSTOM = 'custom'¶

EXTERNAL = 'external'¶

SYSTEM = 'system'¶

class azure.mgmt.apimanagement.models.GroupUpdateParameters(*, display_name: Optional[str] = None, description: Optional[str] = None, type: Optional[Union[str, _models.GroupType]] = None, external_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Parameters supplied to the Update Group operation.

Variables

display_name (str) – Group name.
description (str) – Group description.
type (str or GroupType) – Group type. Known values are: “custom”, “system”, and “external”.
external_id (str) – Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

Keyword Arguments

display_name (str) – Group name.
description (str) – Group description.
type (str or GroupType) – Group type. Known values are: “custom”, “system”, and “external”.
external_id (str) – Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; otherwise the value is null.

class azure.mgmt.apimanagement.models.HTTPHeader(*, name: str, value: str, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

HTTP header and it’s value.

All required parameters must be populated in order to send to Azure.

Variables

name (str) – Header name. Required.
value (str) – Header value. Required.

Keyword Arguments

name (str) – Header name. Required.
value (str) – Header value. Required.

class azure.mgmt.apimanagement.models.HostnameConfiguration(*, type: Union[str, _models.HostnameType], host_name: str, key_vault_id: Optional[str] = None, identity_client_id: Optional[str] = None, encoded_certificate: Optional[str] = None, certificate_password: Optional[str] = None, default_ssl_binding: bool = False, negotiate_client_certificate: bool = False, certificate: Optional[_models.CertificateInformation] = None, certificate_source: Optional[Union[str, _models.CertificateSource]] = None, certificate_status: Optional[Union[str, _models.CertificateStatus]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Custom hostname configuration.

All required parameters must be populated in order to send to Azure.

Variables

type (str or HostnameType) – Hostname type. Required. Known values are: “Proxy”, “Portal”, “Management”, “Scm”, and “DeveloperPortal”.
host_name (str) – Hostname to configure on the Api Management service. Required.
key_vault_id (str) – 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.
identity_client_id (str) – System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
encoded_certificate (str) – Base64 Encoded certificate.
certificate_password (str) – Certificate Password.
default_ssl_binding (bool) – 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 Proxy Hostname Type.
negotiate_client_certificate (bool) – Specify true to always negotiate client certificate on the hostname. Default Value is false.
certificate (CertificateInformation) – Certificate information.
certificate_source (str or CertificateSource) – Certificate Source. Known values are: “Managed”, “KeyVault”, “Custom”, and “BuiltIn”.
certificate_status (str or CertificateStatus) – Certificate Status. Known values are: “Completed”, “Failed”, and “InProgress”.

Keyword Arguments

type (str or HostnameType) – Hostname type. Required. Known values are: “Proxy”, “Portal”, “Management”, “Scm”, and “DeveloperPortal”.
host_name (str) – Hostname to configure on the Api Management service. Required.
key_vault_id (str) – 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.
identity_client_id (str) – System or User Assigned Managed identity clientId as generated by Azure AD, which has GET access to the keyVault containing the SSL certificate.
encoded_certificate (str) – Base64 Encoded certificate.
certificate_password (str) – Certificate Password.
default_ssl_binding (bool) – 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 Proxy Hostname Type.
negotiate_client_certificate (bool) – Specify true to always negotiate client certificate on the hostname. Default Value is false.
certificate (CertificateInformation) – Certificate information.
certificate_source (str or CertificateSource) – Certificate Source. Known values are: “Managed”, “KeyVault”, “Custom”, and “BuiltIn”.
certificate_status (str or CertificateStatus) – Certificate Status. Known values are: “Completed”, “Failed”, and “InProgress”.

class azure.mgmt.apimanagement.models.HostnameType(value)[source]¶

Bases: str, enum.Enum

Hostname type.

DEVELOPER_PORTAL = 'DeveloperPortal'¶

MANAGEMENT = 'Management'¶

PORTAL = 'Portal'¶

PROXY = 'Proxy'¶

SCM = 'Scm'¶

class azure.mgmt.apimanagement.models.HttpCorrelationProtocol(value)[source]¶

Bases: str, enum.Enum

Sets correlation protocol to use for Application Insights diagnostics.

LEGACY = 'Legacy'¶: Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.

NONE = 'None'¶: Do not read and inject correlation headers.

W3_C = 'W3C'¶

//w3c.github.io/trace-context.

Type: Inject Trace Context headers. See https

class azure.mgmt.apimanagement.models.HttpMessageDiagnostic(*, headers: Optional[List[str]] = None, body: Optional[_models.BodyDiagnosticSettings] = None, data_masking: Optional[_models.DataMasking] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Http message diagnostic settings.

Variables

headers (list[str]) – Array of HTTP Headers to log.
body (BodyDiagnosticSettings) – Body logging settings.
data_masking (DataMasking) – Data masking settings.

Keyword Arguments

headers (list[str]) – Array of HTTP Headers to log.
body (BodyDiagnosticSettings) – Body logging settings.
data_masking (DataMasking) – Data masking settings.

class azure.mgmt.apimanagement.models.IdentityProviderBaseParameters(*, type: Optional[Union[str, _models.IdentityProviderType]] = None, signin_tenant: Optional[str] = None, allowed_tenants: Optional[List[str]] = None, authority: Optional[str] = None, signup_policy_name: Optional[str] = None, signin_policy_name: Optional[str] = None, profile_editing_policy_name: Optional[str] = None, password_reset_policy_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Identity Provider Base Parameter Properties.

Variables

type (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”.
signin_tenant (str) – The TenantId to use instead of Common when logging into Active Directory.
allowed_tenants (list[str]) – List of Allowed Tenants when configuring Azure Active Directory login.
authority (str) – OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
signup_policy_name (str) – Signup Policy Name. Only applies to AAD B2C Identity Provider.
signin_policy_name (str) – Signin Policy Name. Only applies to AAD B2C Identity Provider.
profile_editing_policy_name (str) – Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
password_reset_policy_name (str) – Password Reset Policy Name. Only applies to AAD B2C Identity Provider.

Keyword Arguments

type (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”.
signin_tenant (str) – The TenantId to use instead of Common when logging into Active Directory.
allowed_tenants (list[str]) – List of Allowed Tenants when configuring Azure Active Directory login.
authority (str) – OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
signup_policy_name (str) – Signup Policy Name. Only applies to AAD B2C Identity Provider.
signin_policy_name (str) – Signin Policy Name. Only applies to AAD B2C Identity Provider.
profile_editing_policy_name (str) – Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
password_reset_policy_name (str) – Password Reset Policy Name. Only applies to AAD B2C Identity Provider.

class azure.mgmt.apimanagement.models.IdentityProviderContract(*, type_properties_type: Optional[Union[str, _models.IdentityProviderType]] = None, signin_tenant: Optional[str] = None, allowed_tenants: Optional[List[str]] = None, authority: Optional[str] = None, signup_policy_name: Optional[str] = None, signin_policy_name: Optional[str] = None, profile_editing_policy_name: Optional[str] = None, password_reset_policy_name: Optional[str] = None, client_id: Optional[str] = None, client_secret: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Identity Provider details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
type_properties_type (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”.
signin_tenant (str) – The TenantId to use instead of Common when logging into Active Directory.
allowed_tenants (list[str]) – List of Allowed Tenants when configuring Azure Active Directory login.
authority (str) – OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
signup_policy_name (str) – Signup Policy Name. Only applies to AAD B2C Identity Provider.
signin_policy_name (str) – Signin Policy Name. Only applies to AAD B2C Identity Provider.
profile_editing_policy_name (str) – Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
password_reset_policy_name (str) – Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
client_id (str) – Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
client_secret (str) – Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.

Keyword Arguments

type_properties_type (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”.
signin_tenant (str) – The TenantId to use instead of Common when logging into Active Directory.
allowed_tenants (list[str]) – List of Allowed Tenants when configuring Azure Active Directory login.
authority (str) – OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
signup_policy_name (str) – Signup Policy Name. Only applies to AAD B2C Identity Provider.
signin_policy_name (str) – Signin Policy Name. Only applies to AAD B2C Identity Provider.
profile_editing_policy_name (str) – Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
password_reset_policy_name (str) – Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
client_id (str) – Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
client_secret (str) – Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.

class azure.mgmt.apimanagement.models.IdentityProviderContractProperties(*, client_id: str, type: Optional[Union[str, _models.IdentityProviderType]] = None, signin_tenant: Optional[str] = None, allowed_tenants: Optional[List[str]] = None, authority: Optional[str] = None, signup_policy_name: Optional[str] = None, signin_policy_name: Optional[str] = None, profile_editing_policy_name: Optional[str] = None, password_reset_policy_name: Optional[str] = None, client_secret: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.IdentityProviderBaseParameters

The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.

All required parameters must be populated in order to send to Azure.

Variables

type (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”.
signin_tenant (str) – The TenantId to use instead of Common when logging into Active Directory.
allowed_tenants (list[str]) – List of Allowed Tenants when configuring Azure Active Directory login.
authority (str) – OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
signup_policy_name (str) – Signup Policy Name. Only applies to AAD B2C Identity Provider.
signin_policy_name (str) – Signin Policy Name. Only applies to AAD B2C Identity Provider.
profile_editing_policy_name (str) – Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
password_reset_policy_name (str) – Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
client_id (str) – Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. Required.
client_secret (str) – Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.

Keyword Arguments

type (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”.
signin_tenant (str) – The TenantId to use instead of Common when logging into Active Directory.
allowed_tenants (list[str]) – List of Allowed Tenants when configuring Azure Active Directory login.
authority (str) – OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
signup_policy_name (str) – Signup Policy Name. Only applies to AAD B2C Identity Provider.
signin_policy_name (str) – Signin Policy Name. Only applies to AAD B2C Identity Provider.
profile_editing_policy_name (str) – Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
password_reset_policy_name (str) – Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
client_id (str) – Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. Required.
client_secret (str) – Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.

class azure.mgmt.apimanagement.models.IdentityProviderCreateContract(*, type_properties_type: Optional[Union[str, _models.IdentityProviderType]] = None, signin_tenant: Optional[str] = None, allowed_tenants: Optional[List[str]] = None, authority: Optional[str] = None, signup_policy_name: Optional[str] = None, signin_policy_name: Optional[str] = None, profile_editing_policy_name: Optional[str] = None, password_reset_policy_name: Optional[str] = None, client_id: Optional[str] = None, client_secret: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Identity Provider details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
type_properties_type (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”.
signin_tenant (str) – The TenantId to use instead of Common when logging into Active Directory.
allowed_tenants (list[str]) – List of Allowed Tenants when configuring Azure Active Directory login.
authority (str) – OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
signup_policy_name (str) – Signup Policy Name. Only applies to AAD B2C Identity Provider.
signin_policy_name (str) – Signin Policy Name. Only applies to AAD B2C Identity Provider.
profile_editing_policy_name (str) – Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
password_reset_policy_name (str) – Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
client_id (str) – Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
client_secret (str) – Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.

Keyword Arguments

type_properties_type (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”.
signin_tenant (str) – The TenantId to use instead of Common when logging into Active Directory.
allowed_tenants (list[str]) – List of Allowed Tenants when configuring Azure Active Directory login.
authority (str) – OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
signup_policy_name (str) – Signup Policy Name. Only applies to AAD B2C Identity Provider.
signin_policy_name (str) – Signin Policy Name. Only applies to AAD B2C Identity Provider.
profile_editing_policy_name (str) – Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
password_reset_policy_name (str) – Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
client_id (str) – Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
client_secret (str) – Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.

class azure.mgmt.apimanagement.models.IdentityProviderCreateContractProperties(*, client_id: str, client_secret: str, type: Optional[Union[str, _models.IdentityProviderType]] = None, signin_tenant: Optional[str] = None, allowed_tenants: Optional[List[str]] = None, authority: Optional[str] = None, signup_policy_name: Optional[str] = None, signin_policy_name: Optional[str] = None, profile_editing_policy_name: Optional[str] = None, password_reset_policy_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.IdentityProviderBaseParameters

The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users.

All required parameters must be populated in order to send to Azure.

Variables

type (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”.
signin_tenant (str) – The TenantId to use instead of Common when logging into Active Directory.
allowed_tenants (list[str]) – List of Allowed Tenants when configuring Azure Active Directory login.
authority (str) – OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
signup_policy_name (str) – Signup Policy Name. Only applies to AAD B2C Identity Provider.
signin_policy_name (str) – Signin Policy Name. Only applies to AAD B2C Identity Provider.
profile_editing_policy_name (str) – Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
password_reset_policy_name (str) – Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
client_id (str) – Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. Required.
client_secret (str) – Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value. Required.

Keyword Arguments

type (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”.
signin_tenant (str) – The TenantId to use instead of Common when logging into Active Directory.
allowed_tenants (list[str]) – List of Allowed Tenants when configuring Azure Active Directory login.
authority (str) – OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
signup_policy_name (str) – Signup Policy Name. Only applies to AAD B2C Identity Provider.
signin_policy_name (str) – Signin Policy Name. Only applies to AAD B2C Identity Provider.
profile_editing_policy_name (str) – Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
password_reset_policy_name (str) – Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
client_id (str) – Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. Required.
client_secret (str) – Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value. Required.

class azure.mgmt.apimanagement.models.IdentityProviderList(*, value: Optional[List[_models.IdentityProviderContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

List of all the Identity Providers configured on the service instance.

Variables

value (list[IdentityProviderContract]) – Identity Provider configuration values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[IdentityProviderContract]) – Identity Provider configuration values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.IdentityProviderType(value)[source]¶

Bases: str, enum.Enum

IdentityProviderType.

AAD = 'aad'¶: Azure Active Directory as Identity provider.

AAD_B2_C = 'aadB2C'¶: Azure Active Directory B2C as Identity provider.

FACEBOOK = 'facebook'¶: Facebook as Identity provider.

GOOGLE = 'google'¶: Google as Identity provider.

MICROSOFT = 'microsoft'¶: Microsoft Live as Identity provider.

TWITTER = 'twitter'¶: Twitter as Identity provider.

class azure.mgmt.apimanagement.models.IdentityProviderUpdateParameters(*, type: Optional[Union[str, _models.IdentityProviderType]] = None, signin_tenant: Optional[str] = None, allowed_tenants: Optional[List[str]] = None, authority: Optional[str] = None, signup_policy_name: Optional[str] = None, signin_policy_name: Optional[str] = None, profile_editing_policy_name: Optional[str] = None, password_reset_policy_name: Optional[str] = None, client_id: Optional[str] = None, client_secret: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Parameters supplied to update Identity Provider.

Variables

type (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”.
signin_tenant (str) – The TenantId to use instead of Common when logging into Active Directory.
allowed_tenants (list[str]) – List of Allowed Tenants when configuring Azure Active Directory login.
authority (str) – OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
signup_policy_name (str) – Signup Policy Name. Only applies to AAD B2C Identity Provider.
signin_policy_name (str) – Signin Policy Name. Only applies to AAD B2C Identity Provider.
profile_editing_policy_name (str) – Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
password_reset_policy_name (str) – Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
client_id (str) – Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
client_secret (str) – Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.

Keyword Arguments

type (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”.
signin_tenant (str) – The TenantId to use instead of Common when logging into Active Directory.
allowed_tenants (list[str]) – List of Allowed Tenants when configuring Azure Active Directory login.
authority (str) – OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
signup_policy_name (str) – Signup Policy Name. Only applies to AAD B2C Identity Provider.
signin_policy_name (str) – Signin Policy Name. Only applies to AAD B2C Identity Provider.
profile_editing_policy_name (str) – Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
password_reset_policy_name (str) – Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
client_id (str) – Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
client_secret (str) – Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.

class azure.mgmt.apimanagement.models.IdentityProviderUpdateProperties(*, type: Optional[Union[str, _models.IdentityProviderType]] = None, signin_tenant: Optional[str] = None, allowed_tenants: Optional[List[str]] = None, authority: Optional[str] = None, signup_policy_name: Optional[str] = None, signin_policy_name: Optional[str] = None, profile_editing_policy_name: Optional[str] = None, password_reset_policy_name: Optional[str] = None, client_id: Optional[str] = None, client_secret: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.IdentityProviderBaseParameters

Parameters supplied to the Update Identity Provider operation.

Variables

type (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”.
signin_tenant (str) – The TenantId to use instead of Common when logging into Active Directory.
allowed_tenants (list[str]) – List of Allowed Tenants when configuring Azure Active Directory login.
authority (str) – OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
signup_policy_name (str) – Signup Policy Name. Only applies to AAD B2C Identity Provider.
signin_policy_name (str) – Signin Policy Name. Only applies to AAD B2C Identity Provider.
profile_editing_policy_name (str) – Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
password_reset_policy_name (str) – Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
client_id (str) – Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
client_secret (str) – Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.

Keyword Arguments

type (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”.
signin_tenant (str) – The TenantId to use instead of Common when logging into Active Directory.
allowed_tenants (list[str]) – List of Allowed Tenants when configuring Azure Active Directory login.
authority (str) – OpenID Connect discovery endpoint hostname for AAD or AAD B2C.
signup_policy_name (str) – Signup Policy Name. Only applies to AAD B2C Identity Provider.
signin_policy_name (str) – Signin Policy Name. Only applies to AAD B2C Identity Provider.
profile_editing_policy_name (str) – Profile Editing Policy Name. Only applies to AAD B2C Identity Provider.
password_reset_policy_name (str) – Password Reset Policy Name. Only applies to AAD B2C Identity Provider.
client_id (str) – Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft.
client_secret (str) – Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft.

class azure.mgmt.apimanagement.models.IssueAttachmentCollection(*, count: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Issue Attachment list representation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[IssueAttachmentContract]) – Issue Attachment values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

count (int) – Total record count number across all pages.

class azure.mgmt.apimanagement.models.IssueAttachmentContract(*, title: Optional[str] = None, content_format: Optional[str] = None, content: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Issue Attachment Contract details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
title (str) – Filename by which the binary data will be saved.
content_format (str) – Either ‘link’ if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the ‘content’ property.
content (str) – An HTTP link or Base64-encoded binary data.

Keyword Arguments

title (str) – Filename by which the binary data will be saved.
content_format (str) – Either ‘link’ if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the ‘content’ property.
content (str) – An HTTP link or Base64-encoded binary data.

class azure.mgmt.apimanagement.models.IssueCollection(*, count: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Issue list representation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[IssueContract]) – Issue values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

count (int) – Total record count number across all pages.

class azure.mgmt.apimanagement.models.IssueCommentCollection(*, count: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Issue Comment list representation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[IssueCommentContract]) – Issue Comment values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

count (int) – Total record count number across all pages.

class azure.mgmt.apimanagement.models.IssueCommentContract(*, text: Optional[str] = None, created_date: Optional[datetime.datetime] = None, user_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Issue Comment Contract details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
text (str) – Comment text.
created_date (datetime) – Date and time when the comment was created.
user_id (str) – A resource identifier for the user who left the comment.

Keyword Arguments

text (str) – Comment text.
created_date (datetime) – Date and time when the comment was created.
user_id (str) – A resource identifier for the user who left the comment.

class azure.mgmt.apimanagement.models.IssueContract(*, created_date: Optional[datetime.datetime] = None, state: Optional[Union[str, _models.State]] = None, api_id: Optional[str] = None, title: Optional[str] = None, description: Optional[str] = None, user_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Issue Contract details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
created_date (datetime) – Date and time when the issue was created.
state (str or State) – Status of the issue. Known values are: “proposed”, “open”, “removed”, “resolved”, and “closed”.
api_id (str) – A resource identifier for the API the issue was created for.
title (str) – The issue title.
description (str) – Text describing the issue.
user_id (str) – A resource identifier for the user created the issue.

Keyword Arguments

created_date (datetime) – Date and time when the issue was created.
state (str or State) – Status of the issue. Known values are: “proposed”, “open”, “removed”, “resolved”, and “closed”.
api_id (str) – A resource identifier for the API the issue was created for.
title (str) – The issue title.
description (str) – Text describing the issue.
user_id (str) – A resource identifier for the user created the issue.

class azure.mgmt.apimanagement.models.IssueContractBaseProperties(*, created_date: Optional[datetime.datetime] = None, state: Optional[Union[str, _models.State]] = None, api_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Issue contract Base Properties.

Variables

created_date (datetime) – Date and time when the issue was created.
state (str or State) – Status of the issue. Known values are: “proposed”, “open”, “removed”, “resolved”, and “closed”.
api_id (str) – A resource identifier for the API the issue was created for.

Keyword Arguments

created_date (datetime) – Date and time when the issue was created.
state (str or State) – Status of the issue. Known values are: “proposed”, “open”, “removed”, “resolved”, and “closed”.
api_id (str) – A resource identifier for the API the issue was created for.

class azure.mgmt.apimanagement.models.IssueContractProperties(*, title: str, description: str, user_id: str, created_date: Optional[datetime.datetime] = None, state: Optional[Union[str, _models.State]] = None, api_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.IssueContractBaseProperties

Issue contract Properties.

All required parameters must be populated in order to send to Azure.

Variables

created_date (datetime) – Date and time when the issue was created.
state (str or State) – Status of the issue. Known values are: “proposed”, “open”, “removed”, “resolved”, and “closed”.
api_id (str) – A resource identifier for the API the issue was created for.
title (str) – The issue title. Required.
description (str) – Text describing the issue. Required.
user_id (str) – A resource identifier for the user created the issue. Required.

Keyword Arguments

created_date (datetime) – Date and time when the issue was created.
state (str or State) – Status of the issue. Known values are: “proposed”, “open”, “removed”, “resolved”, and “closed”.
api_id (str) – A resource identifier for the API the issue was created for.
title (str) – The issue title. Required.
description (str) – Text describing the issue. Required.
user_id (str) – A resource identifier for the user created the issue. Required.

class azure.mgmt.apimanagement.models.IssueType(value)[source]¶

Bases: str, enum.Enum

The type of issue.

AGENT_STOPPED = 'AgentStopped'¶

DNS_RESOLUTION = 'DnsResolution'¶

GUEST_FIREWALL = 'GuestFirewall'¶

NETWORK_SECURITY_RULE = 'NetworkSecurityRule'¶

PLATFORM = 'Platform'¶

PORT_THROTTLED = 'PortThrottled'¶

SOCKET_BIND = 'SocketBind'¶

UNKNOWN = 'Unknown'¶

USER_DEFINED_ROUTE = 'UserDefinedRoute'¶

class azure.mgmt.apimanagement.models.IssueUpdateContract(*, created_date: Optional[datetime.datetime] = None, state: Optional[Union[str, _models.State]] = None, api_id: Optional[str] = None, title: Optional[str] = None, description: Optional[str] = None, user_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Issue update Parameters.

Variables

created_date (datetime) – Date and time when the issue was created.
state (str or State) – Status of the issue. Known values are: “proposed”, “open”, “removed”, “resolved”, and “closed”.
api_id (str) – A resource identifier for the API the issue was created for.
title (str) – The issue title.
description (str) – Text describing the issue.
user_id (str) – A resource identifier for the user created the issue.

Keyword Arguments

created_date (datetime) – Date and time when the issue was created.
state (str or State) – Status of the issue. Known values are: “proposed”, “open”, “removed”, “resolved”, and “closed”.
api_id (str) – A resource identifier for the API the issue was created for.
title (str) – The issue title.
description (str) – Text describing the issue.
user_id (str) – A resource identifier for the user created the issue.

class azure.mgmt.apimanagement.models.IssueUpdateContractProperties(*, created_date: Optional[datetime.datetime] = None, state: Optional[Union[str, _models.State]] = None, api_id: Optional[str] = None, title: Optional[str] = None, description: Optional[str] = None, user_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.IssueContractBaseProperties

Issue contract Update Properties.

Variables

created_date (datetime) – Date and time when the issue was created.
state (str or State) – Status of the issue. Known values are: “proposed”, “open”, “removed”, “resolved”, and “closed”.
api_id (str) – A resource identifier for the API the issue was created for.
title (str) – The issue title.
description (str) – Text describing the issue.
user_id (str) – A resource identifier for the user created the issue.

Keyword Arguments

created_date (datetime) – Date and time when the issue was created.
state (str or State) – Status of the issue. Known values are: “proposed”, “open”, “removed”, “resolved”, and “closed”.
api_id (str) – A resource identifier for the API the issue was created for.
title (str) – The issue title.
description (str) – Text describing the issue.
user_id (str) – A resource identifier for the user created the issue.

class azure.mgmt.apimanagement.models.KeyType(value)[source]¶

Bases: str, enum.Enum

The Key to be used to generate token for user.

PRIMARY = 'primary'¶

SECONDARY = 'secondary'¶

class azure.mgmt.apimanagement.models.KeyVaultContractCreateProperties(*, secret_identifier: Optional[str] = None, identity_client_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Create keyVault contract details.

Variables

secret_identifier (str) – Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi.
identity_client_id (str) – Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.

Keyword Arguments

secret_identifier (str) – Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi.
identity_client_id (str) – Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.

class azure.mgmt.apimanagement.models.KeyVaultContractProperties(*, secret_identifier: Optional[str] = None, identity_client_id: Optional[str] = None, last_status: Optional[_models.KeyVaultLastAccessStatusContractProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.KeyVaultContractCreateProperties

KeyVault contract details.

Variables

secret_identifier (str) – Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi.
identity_client_id (str) – Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
last_status (KeyVaultLastAccessStatusContractProperties) – Last time sync and refresh status of secret from key vault.

Keyword Arguments

secret_identifier (str) – Key vault secret identifier for fetching secret. Providing a versioned secret will prevent auto-refresh. This requires API Management service to be configured with aka.ms/apimmsi.
identity_client_id (str) – Null for SystemAssignedIdentity or Client Id for UserAssignedIdentity , which will be used to access key vault secret.
last_status (KeyVaultLastAccessStatusContractProperties) – Last time sync and refresh status of secret from key vault.

class azure.mgmt.apimanagement.models.KeyVaultLastAccessStatusContractProperties(*, code: Optional[str] = None, message: Optional[str] = None, time_stamp_utc: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Issue contract Update Properties.

Variables

code (str) – Last status code for sync and refresh of secret from key vault.
message (str) – Details of the error else empty.
time_stamp_utc (datetime) – Last time secret was accessed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Keyword Arguments

code (str) – Last status code for sync and refresh of secret from key vault.
message (str) – Details of the error else empty.
time_stamp_utc (datetime) – Last time secret was accessed. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

class azure.mgmt.apimanagement.models.LoggerCollection(*, value: Optional[List[_models.LoggerContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Logger list representation.

Variables

value (list[LoggerContract]) – Logger values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[LoggerContract]) – Logger values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.LoggerContract(*, logger_type: Optional[Union[str, _models.LoggerType]] = None, description: Optional[str] = None, credentials: Optional[Dict[str, str]] = None, is_buffered: Optional[bool] = None, resource_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Logger details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
logger_type (str or LoggerType) – Logger type. Known values are: “azureEventHub”, “applicationInsights”, and “azureMonitor”.
description (str) – Logger description.
credentials (dict[str, str]) – The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger.
is_buffered (bool) – Whether records are buffered in the logger before publishing. Default is assumed to be true.
resource_id (str) – Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource).

Keyword Arguments

logger_type (str or LoggerType) – Logger type. Known values are: “azureEventHub”, “applicationInsights”, and “azureMonitor”.
description (str) – Logger description.
credentials (dict[str, str]) – The name and SendRule connection string of the event hub for azureEventHub logger. Instrumentation key for applicationInsights logger.
is_buffered (bool) – Whether records are buffered in the logger before publishing. Default is assumed to be true.
resource_id (str) – Azure Resource Id of a log target (either Azure Event Hub resource or Azure Application Insights resource).

class azure.mgmt.apimanagement.models.LoggerType(value)[source]¶

Bases: str, enum.Enum

Logger type.

APPLICATION_INSIGHTS = 'applicationInsights'¶: Azure Application Insights as log destination.

AZURE_EVENT_HUB = 'azureEventHub'¶: Azure Event Hub as log destination.

AZURE_MONITOR = 'azureMonitor'¶: Azure Monitor

class azure.mgmt.apimanagement.models.LoggerUpdateContract(*, logger_type: Optional[Union[str, _models.LoggerType]] = None, description: Optional[str] = None, credentials: Optional[Dict[str, str]] = None, is_buffered: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Logger update contract.

Variables

logger_type (str or LoggerType) – Logger type. Known values are: “azureEventHub”, “applicationInsights”, and “azureMonitor”.
description (str) – Logger description.
credentials (dict[str, str]) – Logger credentials.
is_buffered (bool) – Whether records are buffered in the logger before publishing. Default is assumed to be true.

Keyword Arguments

logger_type (str or LoggerType) – Logger type. Known values are: “azureEventHub”, “applicationInsights”, and “azureMonitor”.
description (str) – Logger description.
credentials (dict[str, str]) – Logger credentials.
is_buffered (bool) – Whether records are buffered in the logger before publishing. Default is assumed to be true.

class azure.mgmt.apimanagement.models.Method(value)[source]¶

Bases: str, enum.Enum

The HTTP method to be used.

GET = 'GET'¶

POST = 'POST'¶

class azure.mgmt.apimanagement.models.NameAvailabilityReason(value)[source]¶

Bases: str, enum.Enum

Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable.

ALREADY_EXISTS = 'AlreadyExists'¶

INVALID = 'Invalid'¶

VALID = 'Valid'¶

class azure.mgmt.apimanagement.models.NamedValueCollection(*, value: Optional[List[_models.NamedValueContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged NamedValue list representation.

Variables

value (list[NamedValueContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[NamedValueContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.NamedValueContract(*, tags: Optional[List[str]] = None, secret: Optional[bool] = None, display_name: Optional[str] = None, value: Optional[str] = None, key_vault: Optional[_models.KeyVaultContractProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

NamedValue details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
tags (list[str]) – Optional tags that when provided can be used to filter the NamedValue list.
secret (bool) – Determines whether the value is a secret and should be encrypted or not. Default value is false.
display_name (str) – Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
value (str) – Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
key_vault (KeyVaultContractProperties) – KeyVault location details of the namedValue.

Keyword Arguments

tags (list[str]) – Optional tags that when provided can be used to filter the NamedValue list.
secret (bool) – Determines whether the value is a secret and should be encrypted or not. Default value is false.
display_name (str) – Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
value (str) – Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
key_vault (KeyVaultContractProperties) – KeyVault location details of the namedValue.

class azure.mgmt.apimanagement.models.NamedValueContractProperties(*, display_name: str, tags: Optional[List[str]] = None, secret: Optional[bool] = None, value: Optional[str] = None, key_vault: Optional[_models.KeyVaultContractProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.NamedValueEntityBaseParameters

NamedValue Contract properties.

All required parameters must be populated in order to send to Azure.

Variables

tags (list[str]) – Optional tags that when provided can be used to filter the NamedValue list.
secret (bool) – Determines whether the value is a secret and should be encrypted or not. Default value is false.
display_name (str) – Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. Required.
value (str) – Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
key_vault (KeyVaultContractProperties) – KeyVault location details of the namedValue.

Keyword Arguments

tags (list[str]) – Optional tags that when provided can be used to filter the NamedValue list.
secret (bool) – Determines whether the value is a secret and should be encrypted or not. Default value is false.
display_name (str) – Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. Required.
value (str) – Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
key_vault (KeyVaultContractProperties) – KeyVault location details of the namedValue.

class azure.mgmt.apimanagement.models.NamedValueCreateContract(*, tags: Optional[List[str]] = None, secret: Optional[bool] = None, display_name: Optional[str] = None, value: Optional[str] = None, key_vault: Optional[_models.KeyVaultContractCreateProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

NamedValue details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
tags (list[str]) – Optional tags that when provided can be used to filter the NamedValue list.
secret (bool) – Determines whether the value is a secret and should be encrypted or not. Default value is false.
display_name (str) – Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
value (str) – Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
key_vault (KeyVaultContractCreateProperties) – KeyVault location details of the namedValue.

Keyword Arguments

tags (list[str]) – Optional tags that when provided can be used to filter the NamedValue list.
secret (bool) – Determines whether the value is a secret and should be encrypted or not. Default value is false.
display_name (str) – Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
value (str) – Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
key_vault (KeyVaultContractCreateProperties) – KeyVault location details of the namedValue.

class azure.mgmt.apimanagement.models.NamedValueCreateContractProperties(*, display_name: str, tags: Optional[List[str]] = None, secret: Optional[bool] = None, value: Optional[str] = None, key_vault: Optional[_models.KeyVaultContractCreateProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.NamedValueEntityBaseParameters

NamedValue Contract properties.

All required parameters must be populated in order to send to Azure.

Variables

tags (list[str]) – Optional tags that when provided can be used to filter the NamedValue list.
secret (bool) – Determines whether the value is a secret and should be encrypted or not. Default value is false.
display_name (str) – Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. Required.
value (str) – Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
key_vault (KeyVaultContractCreateProperties) – KeyVault location details of the namedValue.

Keyword Arguments

tags (list[str]) – Optional tags that when provided can be used to filter the NamedValue list.
secret (bool) – Determines whether the value is a secret and should be encrypted or not. Default value is false.
display_name (str) – Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters. Required.
value (str) – Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
key_vault (KeyVaultContractCreateProperties) – KeyVault location details of the namedValue.

class azure.mgmt.apimanagement.models.NamedValueEntityBaseParameters(*, tags: Optional[List[str]] = None, secret: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

NamedValue Entity Base Parameters set.

Variables

tags (list[str]) – Optional tags that when provided can be used to filter the NamedValue list.
secret (bool) – Determines whether the value is a secret and should be encrypted or not. Default value is false.

Keyword Arguments

tags (list[str]) – Optional tags that when provided can be used to filter the NamedValue list.
secret (bool) – Determines whether the value is a secret and should be encrypted or not. Default value is false.

class azure.mgmt.apimanagement.models.NamedValueSecretContract(*, value: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.

Variables: value (str) – This is secret value of the NamedValue entity.
Keyword Arguments: value (str) – This is secret value of the NamedValue entity.

class azure.mgmt.apimanagement.models.NamedValueUpdateParameterProperties(*, tags: Optional[List[str]] = None, secret: Optional[bool] = None, display_name: Optional[str] = None, value: Optional[str] = None, key_vault: Optional[_models.KeyVaultContractCreateProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.NamedValueEntityBaseParameters

NamedValue Contract properties.

Variables

tags (list[str]) – Optional tags that when provided can be used to filter the NamedValue list.
secret (bool) – Determines whether the value is a secret and should be encrypted or not. Default value is false.
display_name (str) – Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
value (str) – Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace.
key_vault (KeyVaultContractCreateProperties) – KeyVault location details of the namedValue.

Keyword Arguments

tags (list[str]) – Optional tags that when provided can be used to filter the NamedValue list.
secret (bool) – Determines whether the value is a secret and should be encrypted or not. Default value is false.
display_name (str) – Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
value (str) – Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace.
key_vault (KeyVaultContractCreateProperties) – KeyVault location details of the namedValue.

class azure.mgmt.apimanagement.models.NamedValueUpdateParameters(*, tags: Optional[List[str]] = None, secret: Optional[bool] = None, display_name: Optional[str] = None, value: Optional[str] = None, key_vault: Optional[_models.KeyVaultContractCreateProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

NamedValue update Parameters.

Variables

tags (list[str]) – Optional tags that when provided can be used to filter the NamedValue list.
secret (bool) – Determines whether the value is a secret and should be encrypted or not. Default value is false.
display_name (str) – Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
value (str) – Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace.
key_vault (KeyVaultContractCreateProperties) – KeyVault location details of the namedValue.

Keyword Arguments

tags (list[str]) – Optional tags that when provided can be used to filter the NamedValue list.
secret (bool) – Determines whether the value is a secret and should be encrypted or not. Default value is false.
display_name (str) – Unique name of NamedValue. It may contain only letters, digits, period, dash, and underscore characters.
value (str) – Value of the NamedValue. Can contain policy expressions. It may not be empty or consist only of whitespace.
key_vault (KeyVaultContractCreateProperties) – KeyVault location details of the namedValue.

class azure.mgmt.apimanagement.models.NetworkStatusContract(*, dns_servers: List[str], connectivity_status: List[_models.ConnectivityStatusContract], **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Network Status details.

All required parameters must be populated in order to send to Azure.

Variables

dns_servers (list[str]) – Gets the list of DNS servers IPV4 addresses. Required.
connectivity_status (list[ConnectivityStatusContract]) – Gets the list of Connectivity Status to the Resources on which the service depends upon. Required.

Keyword Arguments

dns_servers (list[str]) – Gets the list of DNS servers IPV4 addresses. Required.
connectivity_status (list[ConnectivityStatusContract]) – Gets the list of Connectivity Status to the Resources on which the service depends upon. Required.

class azure.mgmt.apimanagement.models.NetworkStatusContractByLocation(*, location: Optional[str] = None, network_status: Optional[_models.NetworkStatusContract] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Network Status in the Location.

Variables

location (str) – Location of service.
network_status (NetworkStatusContract) – Network status in Location.

Keyword Arguments

location (str) – Location of service.
network_status (NetworkStatusContract) – Network status in Location.

class azure.mgmt.apimanagement.models.NotificationCollection(*, value: Optional[List[_models.NotificationContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Notification list representation.

Variables

value (list[NotificationContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[NotificationContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.NotificationContract(*, title: Optional[str] = None, description: Optional[str] = None, recipients: Optional[_models.RecipientsContractProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Notification details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
title (str) – Title of the Notification.
description (str) – Description of the Notification.
recipients (RecipientsContractProperties) – Recipient Parameter values.

Keyword Arguments

title (str) – Title of the Notification.
description (str) – Description of the Notification.
recipients (RecipientsContractProperties) – Recipient Parameter values.

class azure.mgmt.apimanagement.models.NotificationName(value)[source]¶

Bases: str, enum.Enum

NotificationName.

ACCOUNT_CLOSED_PUBLISHER = 'AccountClosedPublisher'¶: The following email recipients and users will receive email notifications when developer closes his account.

BCC = 'BCC'¶: The following recipients will receive blind carbon copies of all emails sent to developers.

NEW_APPLICATION_NOTIFICATION_MESSAGE = 'NewApplicationNotificationMessage'¶: The following email recipients and users will receive email notifications when new applications are submitted to the application gallery.

NEW_ISSUE_PUBLISHER_NOTIFICATION_MESSAGE = 'NewIssuePublisherNotificationMessage'¶: The following email recipients and users will receive email notifications when a new issue or comment is submitted on the developer portal.

PURCHASE_PUBLISHER_NOTIFICATION_MESSAGE = 'PurchasePublisherNotificationMessage'¶: The following email recipients and users will receive email notifications about new API product subscriptions.

QUOTA_LIMIT_APPROACHING_PUBLISHER_NOTIFICATION_MESSAGE = 'QuotaLimitApproachingPublisherNotificationMessage'¶: The following email recipients and users will receive email notifications when subscription usage gets close to usage quota.

REQUEST_PUBLISHER_NOTIFICATION_MESSAGE = 'RequestPublisherNotificationMessage'¶: The following email recipients and users will receive email notifications about subscription requests for API products requiring approval.

class azure.mgmt.apimanagement.models.OAuth2AuthenticationSettingsContract(*, authorization_server_id: Optional[str] = None, scope: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

API OAuth2 Authentication settings details.

Variables

authorization_server_id (str) – OAuth authorization server identifier.
scope (str) – operations scope.

Keyword Arguments

authorization_server_id (str) – OAuth authorization server identifier.
scope (str) – operations scope.

class azure.mgmt.apimanagement.models.OpenIdAuthenticationSettingsContract(*, openid_provider_id: Optional[str] = None, bearer_token_sending_methods: Optional[List[Union[str, _models.BearerTokenSendingMethods]]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

API OAuth2 Authentication settings details.

Variables

openid_provider_id (str) – OAuth authorization server identifier.
bearer_token_sending_methods (list[str or BearerTokenSendingMethods]) – How to send token to the server.

Keyword Arguments

openid_provider_id (str) – OAuth authorization server identifier.
bearer_token_sending_methods (list[str or BearerTokenSendingMethods]) – How to send token to the server.

class azure.mgmt.apimanagement.models.OpenIdConnectProviderCollection(*, value: Optional[List[_models.OpenidConnectProviderContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged OpenIdProviders list representation.

Variables

value (list[OpenidConnectProviderContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[OpenidConnectProviderContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.OpenidConnectProviderContract(*, display_name: Optional[str] = None, description: Optional[str] = None, metadata_endpoint: Optional[str] = None, client_id: Optional[str] = None, client_secret: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

OpenId Connect Provider details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
display_name (str) – User-friendly OpenID Connect Provider name.
description (str) – User-friendly description of OpenID Connect Provider.
metadata_endpoint (str) – Metadata endpoint URI.
client_id (str) – Client ID of developer console which is the client application.
client_secret (str) – Client Secret of developer console which is the client application.

Keyword Arguments

display_name (str) – User-friendly OpenID Connect Provider name.
description (str) – User-friendly description of OpenID Connect Provider.
metadata_endpoint (str) – Metadata endpoint URI.
client_id (str) – Client ID of developer console which is the client application.
client_secret (str) – Client Secret of developer console which is the client application.

class azure.mgmt.apimanagement.models.OpenidConnectProviderUpdateContract(*, display_name: Optional[str] = None, description: Optional[str] = None, metadata_endpoint: Optional[str] = None, client_id: Optional[str] = None, client_secret: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Parameters supplied to the Update OpenID Connect Provider operation.

Variables

display_name (str) – User-friendly OpenID Connect Provider name.
description (str) – User-friendly description of OpenID Connect Provider.
metadata_endpoint (str) – Metadata endpoint URI.
client_id (str) – Client ID of developer console which is the client application.
client_secret (str) – Client Secret of developer console which is the client application.

Keyword Arguments

display_name (str) – User-friendly OpenID Connect Provider name.
description (str) – User-friendly description of OpenID Connect Provider.
metadata_endpoint (str) – Metadata endpoint URI.
client_id (str) – Client ID of developer console which is the client application.
client_secret (str) – Client Secret of developer console which is the client application.

class azure.mgmt.apimanagement.models.Operation(*, name: Optional[str] = None, display: Optional[_models.OperationDisplay] = None, origin: Optional[str] = None, properties: Optional[collections.abc.MutableMapping[str, Any]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

REST API operation.

Variables

name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplay) – The object that describes the operation.
origin (str) – The operation origin.
properties (JSON) – The operation properties.

Keyword Arguments

name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDisplay) – The object that describes the operation.
origin (str) – The operation origin.
properties (JSON) – The operation properties.

class azure.mgmt.apimanagement.models.OperationCollection(*, count: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Operation list representation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[OperationContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

count (int) – Total record count number across all pages.

class azure.mgmt.apimanagement.models.OperationContract(*, template_parameters: Optional[List[_models.ParameterContract]] = None, description: Optional[str] = None, request: Optional[_models.RequestContract] = None, responses: Optional[List[_models.ResponseContract]] = None, policies: Optional[str] = None, display_name: Optional[str] = None, method: Optional[str] = None, url_template: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

API Operation details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
template_parameters (list[ParameterContract]) – Collection of URL template parameters.
description (str) – Description of the operation. May include HTML formatting tags.
request (RequestContract) – An entity containing request details.
responses (list[ResponseContract]) – Array of Operation responses.
policies (str) – Operation Policies.
display_name (str) – Operation Name.
method (str) – A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
url_template (str) – Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}.

Keyword Arguments

template_parameters (list[ParameterContract]) – Collection of URL template parameters.
description (str) – Description of the operation. May include HTML formatting tags.
request (RequestContract) – An entity containing request details.
responses (list[ResponseContract]) – Array of Operation responses.
policies (str) – Operation Policies.
display_name (str) – Operation Name.
method (str) – A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
url_template (str) – Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}.

class azure.mgmt.apimanagement.models.OperationContractProperties(*, display_name: str, method: str, url_template: str, template_parameters: Optional[List[_models.ParameterContract]] = None, description: Optional[str] = None, request: Optional[_models.RequestContract] = None, responses: Optional[List[_models.ResponseContract]] = None, policies: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.OperationEntityBaseContract

Operation Contract Properties.

All required parameters must be populated in order to send to Azure.

Variables

template_parameters (list[ParameterContract]) – Collection of URL template parameters.
description (str) – Description of the operation. May include HTML formatting tags.
request (RequestContract) – An entity containing request details.
responses (list[ResponseContract]) – Array of Operation responses.
policies (str) – Operation Policies.
display_name (str) – Operation Name. Required.
method (str) – A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. Required.
url_template (str) – Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}. Required.

Keyword Arguments

template_parameters (list[ParameterContract]) – Collection of URL template parameters.
description (str) – Description of the operation. May include HTML formatting tags.
request (RequestContract) – An entity containing request details.
responses (list[ResponseContract]) – Array of Operation responses.
policies (str) – Operation Policies.
display_name (str) – Operation Name. Required.
method (str) – A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. Required.
url_template (str) – Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}. Required.

class azure.mgmt.apimanagement.models.OperationDisplay(*, provider: Optional[str] = None, operation: Optional[str] = None, resource: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

The object that describes the operation.

Variables

provider (str) – Friendly name of the resource provider.
operation (str) – Operation type: read, write, delete, listKeys/action, etc.
resource (str) – Resource type on which the operation is performed.
description (str) – Friendly name of the operation.

Keyword Arguments

provider (str) – Friendly name of the resource provider.
operation (str) – Operation type: read, write, delete, listKeys/action, etc.
resource (str) – Resource type on which the operation is performed.
description (str) – Friendly name of the operation.

class azure.mgmt.apimanagement.models.OperationEntityBaseContract(*, template_parameters: Optional[List[_models.ParameterContract]] = None, description: Optional[str] = None, request: Optional[_models.RequestContract] = None, responses: Optional[List[_models.ResponseContract]] = None, policies: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

API Operation Entity Base Contract details.

Variables

template_parameters (list[ParameterContract]) – Collection of URL template parameters.
description (str) – Description of the operation. May include HTML formatting tags.
request (RequestContract) – An entity containing request details.
responses (list[ResponseContract]) – Array of Operation responses.
policies (str) – Operation Policies.

Keyword Arguments

template_parameters (list[ParameterContract]) – Collection of URL template parameters.
description (str) – Description of the operation. May include HTML formatting tags.
request (RequestContract) – An entity containing request details.
responses (list[ResponseContract]) – Array of Operation responses.
policies (str) – Operation Policies.

class azure.mgmt.apimanagement.models.OperationListResult(*, value: Optional[List[_models.Operation]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.

Variables

value (list[Operation]) – List of operations supported by the resource provider.
next_link (str) – URL to get the next set of operation list results if there are any.

Keyword Arguments

value (list[Operation]) – List of operations supported by the resource provider.
next_link (str) – URL to get the next set of operation list results if there are any.

class azure.mgmt.apimanagement.models.OperationNameFormat(value)[source]¶

Bases: str, enum.Enum

The format of the Operation Name for Application Insights telemetries. Default is Name.

NAME = 'Name'¶: API_NAME;rev=API_REVISION - OPERATION_NAME

URL = 'Url'¶: HTTP_VERB URL

class azure.mgmt.apimanagement.models.OperationResultContract(*, id_properties_id: Optional[str] = None, status: Optional[Union[str, _models.AsyncOperationStatus]] = None, started: Optional[datetime.datetime] = None, updated: Optional[datetime.datetime] = None, result_info: Optional[str] = None, error: Optional[_models.ErrorResponseBody] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Long Running Git Operation Results.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
id_properties_id (str) – Operation result identifier.
status (str or AsyncOperationStatus) – Status of an async operation. Known values are: “Started”, “InProgress”, “Succeeded”, and “Failed”.
started (datetime) – Start time of an async operation. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
updated (datetime) – Last update time of an async operation. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
result_info (str) – Optional result info.
error (ErrorResponseBody) – Error Body Contract.
action_log (list[OperationResultLogItemContract]) – This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation.

Keyword Arguments

id_properties_id (str) – Operation result identifier.
status (str or AsyncOperationStatus) – Status of an async operation. Known values are: “Started”, “InProgress”, “Succeeded”, and “Failed”.
started (datetime) – Start time of an async operation. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
updated (datetime) – Last update time of an async operation. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
result_info (str) – Optional result info.
error (ErrorResponseBody) – Error Body Contract.

class azure.mgmt.apimanagement.models.OperationResultLogItemContract(*, object_type: Optional[str] = None, action: Optional[str] = None, object_key: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Log of the entity being created, updated or deleted.

Variables

object_type (str) – The type of entity contract.
action (str) – Action like create/update/delete.
object_key (str) – Identifier of the entity being created/updated/deleted.

Keyword Arguments

object_type (str) – The type of entity contract.
action (str) – Action like create/update/delete.
object_key (str) – Identifier of the entity being created/updated/deleted.

class azure.mgmt.apimanagement.models.OperationTagResourceContractProperties(*, id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Operation Entity contract Properties.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Identifier of the operation in form /operations/{operationId}.
name (str) – Operation name.
api_name (str) – API Name.
api_revision (str) – API Revision.
api_version (str) – API Version.
description (str) – Operation Description.
method (str) – A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
url_template (str) – Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}.

Keyword Arguments

id (str) – Identifier of the operation in form /operations/{operationId}.

class azure.mgmt.apimanagement.models.OperationUpdateContract(*, template_parameters: Optional[List[_models.ParameterContract]] = None, description: Optional[str] = None, request: Optional[_models.RequestContract] = None, responses: Optional[List[_models.ResponseContract]] = None, policies: Optional[str] = None, display_name: Optional[str] = None, method: Optional[str] = None, url_template: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

API Operation Update Contract details.

Variables

template_parameters (list[ParameterContract]) – Collection of URL template parameters.
description (str) – Description of the operation. May include HTML formatting tags.
request (RequestContract) – An entity containing request details.
responses (list[ResponseContract]) – Array of Operation responses.
policies (str) – Operation Policies.
display_name (str) – Operation Name.
method (str) – A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
url_template (str) – Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}.

Keyword Arguments

template_parameters (list[ParameterContract]) – Collection of URL template parameters.
description (str) – Description of the operation. May include HTML formatting tags.
request (RequestContract) – An entity containing request details.
responses (list[ResponseContract]) – Array of Operation responses.
policies (str) – Operation Policies.
display_name (str) – Operation Name.
method (str) – A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
url_template (str) – Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}.

class azure.mgmt.apimanagement.models.OperationUpdateContractProperties(*, template_parameters: Optional[List[_models.ParameterContract]] = None, description: Optional[str] = None, request: Optional[_models.RequestContract] = None, responses: Optional[List[_models.ResponseContract]] = None, policies: Optional[str] = None, display_name: Optional[str] = None, method: Optional[str] = None, url_template: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.OperationEntityBaseContract

Operation Update Contract Properties.

Variables

template_parameters (list[ParameterContract]) – Collection of URL template parameters.
description (str) – Description of the operation. May include HTML formatting tags.
request (RequestContract) – An entity containing request details.
responses (list[ResponseContract]) – Array of Operation responses.
policies (str) – Operation Policies.
display_name (str) – Operation Name.
method (str) – A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
url_template (str) – Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}.

Keyword Arguments

template_parameters (list[ParameterContract]) – Collection of URL template parameters.
description (str) – Description of the operation. May include HTML formatting tags.
request (RequestContract) – An entity containing request details.
responses (list[ResponseContract]) – Array of Operation responses.
policies (str) – Operation Policies.
display_name (str) – Operation Name.
method (str) – A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
url_template (str) – Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}.

class azure.mgmt.apimanagement.models.Origin(value)[source]¶

Bases: str, enum.Enum

The origin of the issue.

INBOUND = 'Inbound'¶

LOCAL = 'Local'¶

OUTBOUND = 'Outbound'¶

class azure.mgmt.apimanagement.models.OutboundEnvironmentEndpoint(*, category: Optional[str] = None, endpoints: Optional[List[_models.EndpointDependency]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Endpoints accessed for a common purpose that the Api Management Service requires outbound network access to.

Variables

category (str) – The type of service accessed by the Api Management Service, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory.
endpoints (list[EndpointDependency]) – The endpoints that the Api Management Service reaches the service at.

Keyword Arguments

category (str) – The type of service accessed by the Api Management Service, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory.
endpoints (list[EndpointDependency]) – The endpoints that the Api Management Service reaches the service at.

class azure.mgmt.apimanagement.models.OutboundEnvironmentEndpointList(*, value: List[_models.OutboundEnvironmentEndpoint], **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Collection of Outbound Environment Endpoints.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

value (list[OutboundEnvironmentEndpoint]) – Collection of resources. Required.
next_link (str) – Link to next page of resources.

Keyword Arguments

value (list[OutboundEnvironmentEndpoint]) – Collection of resources. Required.

class azure.mgmt.apimanagement.models.ParameterContract(*, name: str, type: str, description: Optional[str] = None, default_value: Optional[str] = None, required: Optional[bool] = None, values: Optional[List[str]] = None, schema_id: Optional[str] = None, type_name: Optional[str] = None, examples: Optional[Dict[str, _models.ParameterExampleContract]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Operation parameters details.

All required parameters must be populated in order to send to Azure.

Variables

name (str) – Parameter name. Required.
description (str) – Parameter description.
type (str) – Parameter type. Required.
default_value (str) – Default parameter value.
required (bool) – Specifies whether parameter is required or not.
values (list[str]) – Parameter values.
schema_id (str) – Schema identifier.
type_name (str) – Type name defined by the schema.
examples (dict[str, ParameterExampleContract]) – Exampled defined for the parameter.

Keyword Arguments

name (str) – Parameter name. Required.
description (str) – Parameter description.
type (str) – Parameter type. Required.
default_value (str) – Default parameter value.
required (bool) – Specifies whether parameter is required or not.
values (list[str]) – Parameter values.
schema_id (str) – Schema identifier.
type_name (str) – Type name defined by the schema.
examples (dict[str, ParameterExampleContract]) – Exampled defined for the parameter.

class azure.mgmt.apimanagement.models.ParameterExampleContract(*, summary: Optional[str] = None, description: Optional[str] = None, value: Optional[Any] = None, external_value: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Parameter example.

Variables

summary (str) – Short description for the example.
description (str) – Long description for the example.
value (any) – Example value. May be a primitive value, or an object.
external_value (str) – A URL that points to the literal example.

Keyword Arguments

summary (str) – Short description for the example.
description (str) – Long description for the example.
value (any) – Example value. May be a primitive value, or an object.
external_value (str) – A URL that points to the literal example.

class azure.mgmt.apimanagement.models.PipelineDiagnosticSettings(*, request: Optional[_models.HttpMessageDiagnostic] = None, response: Optional[_models.HttpMessageDiagnostic] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.

Variables

request (HttpMessageDiagnostic) – Diagnostic settings for request.
response (HttpMessageDiagnostic) – Diagnostic settings for response.

Keyword Arguments

request (HttpMessageDiagnostic) – Diagnostic settings for request.
response (HttpMessageDiagnostic) – Diagnostic settings for response.

class azure.mgmt.apimanagement.models.PlatformVersion(value)[source]¶

Bases: str, enum.Enum

Compute Platform Version running the service.

MTV1 = 'mtv1'¶: Platform running the service on Multi Tenant V1 platform.

STV1 = 'stv1'¶: Platform running the service on Single Tenant V1 platform.

STV2 = 'stv2'¶: Platform running the service on Single Tenant V2 platform.

UNDETERMINED = 'undetermined'¶: Platform version cannot be determined, as compute platform is not deployed.

class azure.mgmt.apimanagement.models.PolicyCollection(*, value: Optional[List[_models.PolicyContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

The response of the list policy operation.

Variables

value (list[PolicyContract]) – Policy Contract value.
count (int) – Total record count number.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[PolicyContract]) – Policy Contract value.
count (int) – Total record count number.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.PolicyContentFormat(value)[source]¶

Bases: str, enum.Enum

Format of the policyContent.

RAWXML = 'rawxml'¶: The contents are inline and Content type is a non XML encoded policy document.

RAWXML_LINK = 'rawxml-link'¶: The policy document is not Xml encoded and is hosted on a http endpoint accessible from the API Management service.

XML = 'xml'¶: The contents are inline and Content type is an XML document.

XML_LINK = 'xml-link'¶: The policy XML document is hosted on a http endpoint accessible from the API Management service.

class azure.mgmt.apimanagement.models.PolicyContract(*, value: Optional[str] = None, format: Union[str, _models.PolicyContentFormat] = 'xml', **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Policy Contract details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
value (str) – Contents of the Policy as defined by the format.
format (str or PolicyContentFormat) – Format of the policyContent. Known values are: “xml”, “xml-link”, “rawxml”, and “rawxml-link”.

Keyword Arguments

value (str) – Contents of the Policy as defined by the format.
format (str or PolicyContentFormat) – Format of the policyContent. Known values are: “xml”, “xml-link”, “rawxml”, and “rawxml-link”.

class azure.mgmt.apimanagement.models.PolicyDescriptionCollection(*, value: Optional[List[_models.PolicyDescriptionContract]] = None, count: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Descriptions of APIM policies.

Variables

value (list[PolicyDescriptionContract]) – Descriptions of APIM policies.
count (int) – Total record count number.

Keyword Arguments

value (list[PolicyDescriptionContract]) – Descriptions of APIM policies.
count (int) – Total record count number.

class azure.mgmt.apimanagement.models.PolicyDescriptionContract(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Policy description details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
description (str) – Policy description.
scope (int) – Binary OR value of the Snippet scope.

class azure.mgmt.apimanagement.models.PolicyExportFormat(value)[source]¶

Bases: str, enum.Enum

PolicyExportFormat.

RAWXML = 'rawxml'¶: The contents are inline and Content type is a non XML encoded policy document.

XML = 'xml'¶: The contents are inline and Content type is an XML document.

class azure.mgmt.apimanagement.models.PolicyIdName(value)[source]¶

Bases: str, enum.Enum

PolicyIdName.

POLICY = 'policy'¶

class azure.mgmt.apimanagement.models.PolicyScopeContract(value)[source]¶

Bases: str, enum.Enum

PolicyScopeContract.

ALL = 'All'¶

API = 'Api'¶

OPERATION = 'Operation'¶

PRODUCT = 'Product'¶

TENANT = 'Tenant'¶

class azure.mgmt.apimanagement.models.PortalDelegationSettings(*, url: Optional[str] = None, validation_key: Optional[str] = None, subscriptions: Optional[_models.SubscriptionsDelegationSettingsProperties] = None, user_registration: Optional[_models.RegistrationDelegationSettingsProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Delegation settings for a developer portal.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
url (str) – A delegation Url.
validation_key (str) – A base64-encoded validation key to validate, that a request is coming from Azure API Management.
subscriptions (SubscriptionsDelegationSettingsProperties) – Subscriptions delegation settings.
user_registration (RegistrationDelegationSettingsProperties) – User registration delegation settings.

Keyword Arguments

url (str) – A delegation Url.
validation_key (str) – A base64-encoded validation key to validate, that a request is coming from Azure API Management.
subscriptions (SubscriptionsDelegationSettingsProperties) – Subscriptions delegation settings.
user_registration (RegistrationDelegationSettingsProperties) – User registration delegation settings.

class azure.mgmt.apimanagement.models.PortalRevisionCollection(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged list of portal revisions.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[PortalRevisionContract]) – Collection of portal revisions.
next_link (str) – Next page link, if any.

class azure.mgmt.apimanagement.models.PortalRevisionContract(*, description: Optional[str] = None, is_current: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Portal Revision’s contract details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
description (str) – Portal revision description.
status_details (str) – Portal revision publishing status details.
status (str or PortalRevisionStatus) – Status of the portal’s revision. Known values are: “pending”, “publishing”, “completed”, and “failed”.
is_current (bool) – Indicates if the portal’s revision is public.
created_date_time (datetime) – Portal’s revision creation date and time.
updated_date_time (datetime) – Last updated date and time.

Keyword Arguments

description (str) – Portal revision description.
is_current (bool) – Indicates if the portal’s revision is public.

class azure.mgmt.apimanagement.models.PortalRevisionStatus(value)[source]¶

Bases: str, enum.Enum

Status of the portal’s revision.

COMPLETED = 'completed'¶: Portal’s revision publishing completed.

FAILED = 'failed'¶: Portal’s revision publishing failed.

PENDING = 'pending'¶: Portal’s revision has been queued.

PUBLISHING = 'publishing'¶: Portal’s revision is being published.

class azure.mgmt.apimanagement.models.PortalSettingValidationKeyContract(*, validation_key: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Client or app secret used in IdentityProviders, Aad, OpenID or OAuth.

Variables: validation_key (str) – This is secret value of the validation key in portal settings.
Keyword Arguments: validation_key (str) – This is secret value of the validation key in portal settings.

class azure.mgmt.apimanagement.models.PortalSettingsCollection(*, value: Optional[List[_models.PortalSettingsContract]] = None, count: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Descriptions of APIM policies.

Variables

value (list[PortalSettingsContract]) – Descriptions of APIM policies.
count (int) – Total record count number.

Keyword Arguments

value (list[PortalSettingsContract]) – Descriptions of APIM policies.
count (int) – Total record count number.

class azure.mgmt.apimanagement.models.PortalSettingsContract(*, url: Optional[str] = None, validation_key: Optional[str] = None, subscriptions: Optional[_models.SubscriptionsDelegationSettingsProperties] = None, user_registration: Optional[_models.RegistrationDelegationSettingsProperties] = None, enabled: Optional[bool] = None, terms_of_service: Optional[_models.TermsOfServiceProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Portal Settings for the Developer Portal.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
url (str) – A delegation Url.
validation_key (str) – A base64-encoded validation key to validate, that a request is coming from Azure API Management.
subscriptions (SubscriptionsDelegationSettingsProperties) – Subscriptions delegation settings.
user_registration (RegistrationDelegationSettingsProperties) – User registration delegation settings.
enabled (bool) – Redirect Anonymous users to the Sign-In page.
terms_of_service (TermsOfServiceProperties) – Terms of service contract properties.

Keyword Arguments

url (str) – A delegation Url.
validation_key (str) – A base64-encoded validation key to validate, that a request is coming from Azure API Management.
subscriptions (SubscriptionsDelegationSettingsProperties) – Subscriptions delegation settings.
user_registration (RegistrationDelegationSettingsProperties) – User registration delegation settings.
enabled (bool) – Redirect Anonymous users to the Sign-In page.
terms_of_service (TermsOfServiceProperties) – Terms of service contract properties.

class azure.mgmt.apimanagement.models.PortalSigninSettings(*, enabled: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Sign-In settings for the Developer Portal.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
enabled (bool) – Redirect Anonymous users to the Sign-In page.

Keyword Arguments

enabled (bool) – Redirect Anonymous users to the Sign-In page.

class azure.mgmt.apimanagement.models.PortalSignupSettings(*, enabled: Optional[bool] = None, terms_of_service: Optional[_models.TermsOfServiceProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Sign-Up settings for a developer portal.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
enabled (bool) – Allow users to sign up on a developer portal.
terms_of_service (TermsOfServiceProperties) – Terms of service contract properties.

Keyword Arguments

enabled (bool) – Allow users to sign up on a developer portal.
terms_of_service (TermsOfServiceProperties) – Terms of service contract properties.

class azure.mgmt.apimanagement.models.PreferredIPVersion(value)[source]¶

Bases: str, enum.Enum

The IP version to be used. Only IPv4 is supported for now.

I_PV4 = 'IPv4'¶

class azure.mgmt.apimanagement.models.PrivateEndpoint(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

The Private Endpoint resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables: id (str) – The ARM identifier for Private Endpoint.

class azure.mgmt.apimanagement.models.PrivateEndpointConnection(*, private_endpoint: Optional[_models.PrivateEndpoint] = None, private_link_service_connection_state: Optional[_models.PrivateLinkServiceConnectionState] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

The Private Endpoint Connection resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
private_endpoint (PrivateEndpoint) – The resource of private end point.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.
provisioning_state (str or PrivateEndpointConnectionProvisioningState) – The provisioning state of the private endpoint connection resource. Known values are: “Succeeded”, “Creating”, “Deleting”, and “Failed”.

Keyword Arguments

private_endpoint (PrivateEndpoint) – The resource of private end point.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.

class azure.mgmt.apimanagement.models.PrivateEndpointConnectionListResult(*, value: Optional[List[_models.PrivateEndpointConnection]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

List of private endpoint connection associated with the specified storage account.

Variables: value (list[PrivateEndpointConnection]) – Array of private endpoint connections.
Keyword Arguments: value (list[PrivateEndpointConnection]) – Array of private endpoint connections.

class azure.mgmt.apimanagement.models.PrivateEndpointConnectionProvisioningState(value)[source]¶

Bases: str, enum.Enum

The current provisioning state.

CREATING = 'Creating'¶

DELETING = 'Deleting'¶

FAILED = 'Failed'¶

SUCCEEDED = 'Succeeded'¶

class azure.mgmt.apimanagement.models.PrivateEndpointConnectionRequest(*, id: Optional[str] = None, properties: Optional[_models.PrivateEndpointConnectionRequestProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

A request to approve or reject a private endpoint connection.

Variables

id (str) – Private Endpoint Connection Resource Id.
properties (PrivateEndpointConnectionRequestProperties) – The connection state of the private endpoint connection.

Keyword Arguments

id (str) – Private Endpoint Connection Resource Id.
properties (PrivateEndpointConnectionRequestProperties) – The connection state of the private endpoint connection.

class azure.mgmt.apimanagement.models.PrivateEndpointConnectionRequestProperties(*, private_link_service_connection_state: Optional[_models.PrivateLinkServiceConnectionState] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

The connection state of the private endpoint connection.

Variables: private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.
Keyword Arguments: private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.

class azure.mgmt.apimanagement.models.PrivateEndpointServiceConnectionStatus(value)[source]¶

Bases: str, enum.Enum

The private endpoint connection status.

APPROVED = 'Approved'¶

PENDING = 'Pending'¶

REJECTED = 'Rejected'¶

class azure.mgmt.apimanagement.models.PrivateLinkResource(*, required_zone_names: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

A private link resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
group_id (str) – The private link resource group id.
required_members (list[str]) – The private link resource required member names.
required_zone_names (list[str]) – The private link resource Private link DNS zone name.

Keyword Arguments

required_zone_names (list[str]) – The private link resource Private link DNS zone name.

class azure.mgmt.apimanagement.models.PrivateLinkResourceListResult(*, value: Optional[List[_models.PrivateLinkResource]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

A list of private link resources.

Variables: value (list[PrivateLinkResource]) – Array of private link resources.
Keyword Arguments: value (list[PrivateLinkResource]) – Array of private link resources.

class azure.mgmt.apimanagement.models.PrivateLinkServiceConnectionState(*, status: Optional[Union[str, _models.PrivateEndpointServiceConnectionStatus]] = None, description: Optional[str] = None, actions_required: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

A collection of information about the state of the connection between service consumer and provider.

Variables

status (str or PrivateEndpointServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Known values are: “Pending”, “Approved”, and “Rejected”.
description (str) – The reason for approval/rejection of the connection.
actions_required (str) – A message indicating if changes on the service provider require any updates on the consumer.

Keyword Arguments

status (str or PrivateEndpointServiceConnectionStatus) – Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. Known values are: “Pending”, “Approved”, and “Rejected”.
description (str) – The reason for approval/rejection of the connection.
actions_required (str) – A message indicating if changes on the service provider require any updates on the consumer.

class azure.mgmt.apimanagement.models.ProductCollection(*, value: Optional[List[_models.ProductContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Products list representation.

Variables

value (list[ProductContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[ProductContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.ProductContract(*, description: Optional[str] = None, terms: Optional[str] = None, subscription_required: Optional[bool] = None, approval_required: Optional[bool] = None, subscriptions_limit: Optional[int] = None, state: Optional[Union[str, _models.ProductState]] = None, display_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Product details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
description (str) – Product description. May include HTML formatting tags.
terms (str) – Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
subscription_required (bool) – Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as “protected” and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as “open” and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it’s value is assumed to be true.
approval_required (bool) – whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
subscriptions_limit (int) – Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
state (str or ProductState) – whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Known values are: “notPublished” and “published”.
display_name (str) – Product name.

Keyword Arguments

description (str) – Product description. May include HTML formatting tags.
terms (str) – Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
subscription_required (bool) – Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as “protected” and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as “open” and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it’s value is assumed to be true.
approval_required (bool) – whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
subscriptions_limit (int) – Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
state (str or ProductState) – whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Known values are: “notPublished” and “published”.
display_name (str) – Product name.

class azure.mgmt.apimanagement.models.ProductContractProperties(*, display_name: str, description: Optional[str] = None, terms: Optional[str] = None, subscription_required: Optional[bool] = None, approval_required: Optional[bool] = None, subscriptions_limit: Optional[int] = None, state: Optional[Union[str, _models.ProductState]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.ProductEntityBaseParameters

Product profile.

All required parameters must be populated in order to send to Azure.

Variables

description (str) – Product description. May include HTML formatting tags.
terms (str) – Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
subscription_required (bool) – Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as “protected” and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as “open” and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it’s value is assumed to be true.
approval_required (bool) – whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
subscriptions_limit (int) – Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
state (str or ProductState) – whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Known values are: “notPublished” and “published”.
display_name (str) – Product name. Required.

Keyword Arguments

description (str) – Product description. May include HTML formatting tags.
terms (str) – Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
subscription_required (bool) – Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as “protected” and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as “open” and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it’s value is assumed to be true.
approval_required (bool) – whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
subscriptions_limit (int) – Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
state (str or ProductState) – whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Known values are: “notPublished” and “published”.
display_name (str) – Product name. Required.

class azure.mgmt.apimanagement.models.ProductEntityBaseParameters(*, description: Optional[str] = None, terms: Optional[str] = None, subscription_required: Optional[bool] = None, approval_required: Optional[bool] = None, subscriptions_limit: Optional[int] = None, state: Optional[Union[str, _models.ProductState]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Product Entity Base Parameters.

Variables

description (str) – Product description. May include HTML formatting tags.
terms (str) – Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
subscription_required (bool) – Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as “protected” and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as “open” and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it’s value is assumed to be true.
approval_required (bool) – whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
subscriptions_limit (int) – Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
state (str or ProductState) – whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Known values are: “notPublished” and “published”.

Keyword Arguments

description (str) – Product description. May include HTML formatting tags.
terms (str) – Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
subscription_required (bool) – Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as “protected” and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as “open” and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it’s value is assumed to be true.
approval_required (bool) – whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
subscriptions_limit (int) – Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
state (str or ProductState) – whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Known values are: “notPublished” and “published”.

class azure.mgmt.apimanagement.models.ProductState(value)[source]¶

Bases: str, enum.Enum

whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.

NOT_PUBLISHED = 'notPublished'¶

PUBLISHED = 'published'¶

class azure.mgmt.apimanagement.models.ProductTagResourceContractProperties(*, name: str, description: Optional[str] = None, terms: Optional[str] = None, subscription_required: Optional[bool] = None, approval_required: Optional[bool] = None, subscriptions_limit: Optional[int] = None, state: Optional[Union[str, _models.ProductState]] = None, id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.ProductEntityBaseParameters

Product profile.

All required parameters must be populated in order to send to Azure.

Variables

description (str) – Product description. May include HTML formatting tags.
terms (str) – Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
subscription_required (bool) – Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as “protected” and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as “open” and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it’s value is assumed to be true.
approval_required (bool) – whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
subscriptions_limit (int) – Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
state (str or ProductState) – whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Known values are: “notPublished” and “published”.
id (str) – Identifier of the product in the form of /products/{productId}.
name (str) – Product name. Required.

Keyword Arguments

description (str) – Product description. May include HTML formatting tags.
terms (str) – Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
subscription_required (bool) – Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as “protected” and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as “open” and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it’s value is assumed to be true.
approval_required (bool) – whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
subscriptions_limit (int) – Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
state (str or ProductState) – whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Known values are: “notPublished” and “published”.
id (str) – Identifier of the product in the form of /products/{productId}.
name (str) – Product name. Required.

class azure.mgmt.apimanagement.models.ProductUpdateParameters(*, description: Optional[str] = None, terms: Optional[str] = None, subscription_required: Optional[bool] = None, approval_required: Optional[bool] = None, subscriptions_limit: Optional[int] = None, state: Optional[Union[str, _models.ProductState]] = None, display_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Product Update parameters.

Variables

description (str) – Product description. May include HTML formatting tags.
terms (str) – Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
subscription_required (bool) – Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as “protected” and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as “open” and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it’s value is assumed to be true.
approval_required (bool) – whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
subscriptions_limit (int) – Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
state (str or ProductState) – whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Known values are: “notPublished” and “published”.
display_name (str) – Product name.

Keyword Arguments

description (str) – Product description. May include HTML formatting tags.
terms (str) – Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
subscription_required (bool) – Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as “protected” and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as “open” and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it’s value is assumed to be true.
approval_required (bool) – whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
subscriptions_limit (int) – Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
state (str or ProductState) – whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Known values are: “notPublished” and “published”.
display_name (str) – Product name.

class azure.mgmt.apimanagement.models.ProductUpdateProperties(*, description: Optional[str] = None, terms: Optional[str] = None, subscription_required: Optional[bool] = None, approval_required: Optional[bool] = None, subscriptions_limit: Optional[int] = None, state: Optional[Union[str, _models.ProductState]] = None, display_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.ProductEntityBaseParameters

Parameters supplied to the Update Product operation.

Variables

description (str) – Product description. May include HTML formatting tags.
terms (str) – Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
subscription_required (bool) – Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as “protected” and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as “open” and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it’s value is assumed to be true.
approval_required (bool) – whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
subscriptions_limit (int) – Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
state (str or ProductState) – whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Known values are: “notPublished” and “published”.
display_name (str) – Product name.

Keyword Arguments

description (str) – Product description. May include HTML formatting tags.
terms (str) – Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.
subscription_required (bool) – Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as “protected” and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as “open” and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it’s value is assumed to be true.
approval_required (bool) – whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
subscriptions_limit (int) – Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
state (str or ProductState) – whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished. Known values are: “notPublished” and “published”.
display_name (str) – Product name.

class azure.mgmt.apimanagement.models.Protocol(value)[source]¶

Bases: str, enum.Enum

Protocol.

HTTP = 'http'¶

HTTPS = 'https'¶

WS = 'ws'¶

WSS = 'wss'¶

class azure.mgmt.apimanagement.models.PublicNetworkAccess(value)[source]¶

Bases: str, enum.Enum

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’.

DISABLED = 'Disabled'¶

ENABLED = 'Enabled'¶

class azure.mgmt.apimanagement.models.QuotaCounterCollection(*, value: Optional[List[_models.QuotaCounterContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Quota Counter list representation.

Variables

value (list[QuotaCounterContract]) – Quota counter values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[QuotaCounterContract]) – Quota counter values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.QuotaCounterContract(*, counter_key: str, period_key: str, period_start_time: datetime.datetime, period_end_time: datetime.datetime, value: Optional[_models.QuotaCounterValueContractProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Quota counter details.

All required parameters must be populated in order to send to Azure.

Variables

counter_key (str) – The Key value of the Counter. Must not be empty. Required.
period_key (str) – Identifier of the Period for which the counter was collected. Must not be empty. Required.
period_start_time (datetime) – The date of the start of Counter Period. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. Required.
period_end_time (datetime) – The date of the end of Counter Period. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. Required.
value (QuotaCounterValueContractProperties) – Quota Value Properties.

Keyword Arguments

counter_key (str) – The Key value of the Counter. Must not be empty. Required.
period_key (str) – Identifier of the Period for which the counter was collected. Must not be empty. Required.
period_start_time (datetime) – The date of the start of Counter Period. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. Required.
period_end_time (datetime) – The date of the end of Counter Period. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard. Required.
value (QuotaCounterValueContractProperties) – Quota Value Properties.

class azure.mgmt.apimanagement.models.QuotaCounterValueContract(*, calls_count: Optional[int] = None, kb_transferred: Optional[float] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Quota counter value details.

Variables

calls_count (int) – Number of times Counter was called.
kb_transferred (float) – Data Transferred in KiloBytes.

Keyword Arguments

calls_count (int) – Number of times Counter was called.
kb_transferred (float) – Data Transferred in KiloBytes.

class azure.mgmt.apimanagement.models.QuotaCounterValueContractProperties(*, calls_count: Optional[int] = None, kb_transferred: Optional[float] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Quota counter value details.

Variables

calls_count (int) – Number of times Counter was called.
kb_transferred (float) – Data Transferred in KiloBytes.

Keyword Arguments

calls_count (int) – Number of times Counter was called.
kb_transferred (float) – Data Transferred in KiloBytes.

class azure.mgmt.apimanagement.models.QuotaCounterValueUpdateContract(*, calls_count: Optional[int] = None, kb_transferred: Optional[float] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Quota counter value details.

Variables

calls_count (int) – Number of times Counter was called.
kb_transferred (float) – Data Transferred in KiloBytes.

Keyword Arguments

calls_count (int) – Number of times Counter was called.
kb_transferred (float) – Data Transferred in KiloBytes.

class azure.mgmt.apimanagement.models.RecipientEmailCollection(*, value: Optional[List[_models.RecipientEmailContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Recipient User list representation.

Variables

value (list[RecipientEmailContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[RecipientEmailContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.RecipientEmailContract(*, email: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Recipient Email details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
email (str) – User Email subscribed to notification.

Keyword Arguments

email (str) – User Email subscribed to notification.

class azure.mgmt.apimanagement.models.RecipientUserCollection(*, value: Optional[List[_models.RecipientUserContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Recipient User list representation.

Variables

value (list[RecipientUserContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[RecipientUserContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.RecipientUserContract(*, user_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Recipient User details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
user_id (str) – API Management UserId subscribed to notification.

Keyword Arguments

user_id (str) – API Management UserId subscribed to notification.

class azure.mgmt.apimanagement.models.RecipientsContractProperties(*, emails: Optional[List[str]] = None, users: Optional[List[str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Notification Parameter contract.

Variables

emails (list[str]) – List of Emails subscribed for the notification.
users (list[str]) – List of Users subscribed for the notification.

Keyword Arguments

emails (list[str]) – List of Emails subscribed for the notification.
users (list[str]) – List of Users subscribed for the notification.

class azure.mgmt.apimanagement.models.RegionContract(*, is_master_region: Optional[bool] = None, is_deleted: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Region profile.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – Region name.
is_master_region (bool) – whether Region is the master region.
is_deleted (bool) – whether Region is deleted.

Keyword Arguments

is_master_region (bool) – whether Region is the master region.
is_deleted (bool) – whether Region is deleted.

class azure.mgmt.apimanagement.models.RegionListResult(*, value: Optional[List[_models.RegionContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Lists Regions operation response details.

Variables

value (list[RegionContract]) – Lists of Regions.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[RegionContract]) – Lists of Regions.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.RegistrationDelegationSettingsProperties(*, enabled: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

User registration delegation settings properties.

Variables: enabled (bool) – Enable or disable delegation for user registration.
Keyword Arguments: enabled (bool) – Enable or disable delegation for user registration.

class azure.mgmt.apimanagement.models.RemotePrivateEndpointConnectionWrapper(*, id: Optional[str] = None, name: Optional[str] = None, type: Optional[str] = None, private_endpoint: Optional[_models.ArmIdWrapper] = None, private_link_service_connection_state: Optional[_models.PrivateLinkServiceConnectionState] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Remote Private Endpoint Connection resource.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Private Endpoint connection resource id.
name (str) – Private Endpoint Connection Name.
type (str) – Private Endpoint Connection Resource Type.
private_endpoint (ArmIdWrapper) – The resource of private end point.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.
provisioning_state (str) – The provisioning state of the private endpoint connection resource.
group_ids (list[str]) – All the Group ids.

Keyword Arguments

id (str) – Private Endpoint connection resource id.
name (str) – Private Endpoint Connection Name.
type (str) – Private Endpoint Connection Resource Type.
private_endpoint (ArmIdWrapper) – The resource of private end point.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.

class azure.mgmt.apimanagement.models.ReportCollection(*, value: Optional[List[_models.ReportRecordContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Report records list representation.

Variables

value (list[ReportRecordContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[ReportRecordContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.ReportRecordContract(*, name: Optional[str] = None, timestamp: Optional[datetime.datetime] = None, interval: Optional[str] = None, country: Optional[str] = None, region: Optional[str] = None, zip: Optional[str] = None, api_id: Optional[str] = None, operation_id: Optional[str] = None, api_region: Optional[str] = None, subscription_id: Optional[str] = None, call_count_success: Optional[int] = None, call_count_blocked: Optional[int] = None, call_count_failed: Optional[int] = None, call_count_other: Optional[int] = None, call_count_total: Optional[int] = None, bandwidth: Optional[int] = None, cache_hit_count: Optional[int] = None, cache_miss_count: Optional[int] = None, api_time_avg: Optional[float] = None, api_time_min: Optional[float] = None, api_time_max: Optional[float] = None, service_time_avg: Optional[float] = None, service_time_min: Optional[float] = None, service_time_max: Optional[float] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Report data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name (str) – Name depending on report endpoint specifies product, API, operation or developer name.
timestamp (datetime) – Start of aggregation period. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
interval (str) – Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).
country (str) – Country to which this record data is related.
region (str) – Country region to which this record data is related.
zip (str) – Zip code to which this record data is related.
user_id (str) – User identifier path. /users/{userId}.
product_id (str) – Product identifier path. /products/{productId}.
api_id (str) – API identifier path. /apis/{apiId}.
operation_id (str) – Operation identifier path. /apis/{apiId}/operations/{operationId}.
api_region (str) – API region identifier.
subscription_id (str) – Subscription identifier path. /subscriptions/{subscriptionId}.
call_count_success (int) – Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect.
call_count_blocked (int) – Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests.
call_count_failed (int) – Number of calls failed due to proxy or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600.
call_count_other (int) – Number of other calls.
call_count_total (int) – Total number of calls.
bandwidth (int) – Bandwidth consumed.
cache_hit_count (int) – Number of times when content was served from cache policy.
cache_miss_count (int) – Number of times content was fetched from backend.
api_time_avg (float) – Average time it took to process request.
api_time_min (float) – Minimum time it took to process request.
api_time_max (float) – Maximum time it took to process request.
service_time_avg (float) – Average time it took to process request on backend.
service_time_min (float) – Minimum time it took to process request on backend.
service_time_max (float) – Maximum time it took to process request on backend.

Keyword Arguments

name (str) – Name depending on report endpoint specifies product, API, operation or developer name.
timestamp (datetime) – Start of aggregation period. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
interval (str) – Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).
country (str) – Country to which this record data is related.
region (str) – Country region to which this record data is related.
zip (str) – Zip code to which this record data is related.
api_id (str) – API identifier path. /apis/{apiId}.
operation_id (str) – Operation identifier path. /apis/{apiId}/operations/{operationId}.
api_region (str) – API region identifier.
subscription_id (str) – Subscription identifier path. /subscriptions/{subscriptionId}.
call_count_success (int) – Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect.
call_count_blocked (int) – Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests.
call_count_failed (int) – Number of calls failed due to proxy or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600.
call_count_other (int) – Number of other calls.
call_count_total (int) – Total number of calls.
bandwidth (int) – Bandwidth consumed.
cache_hit_count (int) – Number of times when content was served from cache policy.
cache_miss_count (int) – Number of times content was fetched from backend.
api_time_avg (float) – Average time it took to process request.
api_time_min (float) – Minimum time it took to process request.
api_time_max (float) – Maximum time it took to process request.
service_time_avg (float) – Average time it took to process request on backend.
service_time_min (float) – Minimum time it took to process request on backend.
service_time_max (float) – Maximum time it took to process request on backend.

class azure.mgmt.apimanagement.models.RepresentationContract(*, content_type: str, schema_id: Optional[str] = None, type_name: Optional[str] = None, form_parameters: Optional[List[_models.ParameterContract]] = None, examples: Optional[Dict[str, _models.ParameterExampleContract]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Operation request/response representation details.

All required parameters must be populated in order to send to Azure.

Variables

content_type (str) – Specifies a registered or custom content type for this representation, e.g. application/xml. Required.
schema_id (str) – Schema identifier. Applicable only if ‘contentType’ value is neither ‘application/x-www-form-urlencoded’ nor ‘multipart/form-data’.
type_name (str) – Type name defined by the schema. Applicable only if ‘contentType’ value is neither ‘application/x-www-form-urlencoded’ nor ‘multipart/form-data’.
form_parameters (list[ParameterContract]) – Collection of form parameters. Required if ‘contentType’ value is either ‘application/x-www-form-urlencoded’ or ‘multipart/form-data’..
examples (dict[str, ParameterExampleContract]) – Exampled defined for the representation.

Keyword Arguments

content_type (str) – Specifies a registered or custom content type for this representation, e.g. application/xml. Required.
schema_id (str) – Schema identifier. Applicable only if ‘contentType’ value is neither ‘application/x-www-form-urlencoded’ nor ‘multipart/form-data’.
type_name (str) – Type name defined by the schema. Applicable only if ‘contentType’ value is neither ‘application/x-www-form-urlencoded’ nor ‘multipart/form-data’.
form_parameters (list[ParameterContract]) – Collection of form parameters. Required if ‘contentType’ value is either ‘application/x-www-form-urlencoded’ or ‘multipart/form-data’..
examples (dict[str, ParameterExampleContract]) – Exampled defined for the representation.

class azure.mgmt.apimanagement.models.RequestContract(*, description: Optional[str] = None, query_parameters: Optional[List[_models.ParameterContract]] = None, headers: Optional[List[_models.ParameterContract]] = None, representations: Optional[List[_models.RepresentationContract]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Operation request details.

Variables

description (str) – Operation request description.
query_parameters (list[ParameterContract]) – Collection of operation request query parameters.
headers (list[ParameterContract]) – Collection of operation request headers.
representations (list[RepresentationContract]) – Collection of operation request representations.

Keyword Arguments

description (str) – Operation request description.
query_parameters (list[ParameterContract]) – Collection of operation request query parameters.
headers (list[ParameterContract]) – Collection of operation request headers.
representations (list[RepresentationContract]) – Collection of operation request representations.

class azure.mgmt.apimanagement.models.RequestReportCollection(*, value: Optional[List[_models.RequestReportRecordContract]] = None, count: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Report records list representation.

Variables

value (list[RequestReportRecordContract]) – Page values.
count (int) – Total record count number across all pages.

Keyword Arguments

value (list[RequestReportRecordContract]) – Page values.
count (int) – Total record count number across all pages.

class azure.mgmt.apimanagement.models.RequestReportRecordContract(*, api_id: Optional[str] = None, operation_id: Optional[str] = None, method: Optional[str] = None, url: Optional[str] = None, ip_address: Optional[str] = None, backend_response_code: Optional[str] = None, response_code: Optional[int] = None, response_size: Optional[int] = None, timestamp: Optional[datetime.datetime] = None, cache: Optional[str] = None, api_time: Optional[float] = None, service_time: Optional[float] = None, api_region: Optional[str] = None, subscription_id: Optional[str] = None, request_id: Optional[str] = None, request_size: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Request Report data.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

api_id (str) – API identifier path. /apis/{apiId}.
operation_id (str) – Operation identifier path. /apis/{apiId}/operations/{operationId}.
product_id (str) – Product identifier path. /products/{productId}.
user_id (str) – User identifier path. /users/{userId}.
method (str) – The HTTP method associated with this request..
url (str) – The full URL associated with this request.
ip_address (str) – The client IP address associated with this request.
backend_response_code (str) – The HTTP status code received by the gateway as a result of forwarding this request to the backend.
response_code (int) – The HTTP status code returned by the gateway.
response_size (int) – The size of the response returned by the gateway.
timestamp (datetime) – The date and time when this request was received by the gateway in ISO 8601 format.
cache (str) – Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fulfilled by the backend.
api_time (float) – The total time it took to process this request.
service_time (float) – he time it took to forward this request to the backend and get the response back.
api_region (str) – Azure region where the gateway that processed this request is located.
subscription_id (str) – Subscription identifier path. /subscriptions/{subscriptionId}.
request_id (str) – Request Identifier.
request_size (int) – The size of this request..

Keyword Arguments

api_id (str) – API identifier path. /apis/{apiId}.
operation_id (str) – Operation identifier path. /apis/{apiId}/operations/{operationId}.
method (str) – The HTTP method associated with this request..
url (str) – The full URL associated with this request.
ip_address (str) – The client IP address associated with this request.
backend_response_code (str) – The HTTP status code received by the gateway as a result of forwarding this request to the backend.
response_code (int) – The HTTP status code returned by the gateway.
response_size (int) – The size of the response returned by the gateway.
timestamp (datetime) – The date and time when this request was received by the gateway in ISO 8601 format.
cache (str) – Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fulfilled by the backend.
api_time (float) – The total time it took to process this request.
service_time (float) – he time it took to forward this request to the backend and get the response back.
api_region (str) – Azure region where the gateway that processed this request is located.
subscription_id (str) – Subscription identifier path. /subscriptions/{subscriptionId}.
request_id (str) – Request Identifier.
request_size (int) – The size of this request..

class azure.mgmt.apimanagement.models.Resource(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Common fields that are returned in the response for all Azure Resource Manager resources.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.

class azure.mgmt.apimanagement.models.ResourceLocationDataContract(*, name: str, city: Optional[str] = None, district: Optional[str] = None, country_or_region: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Resource location data properties.

All required parameters must be populated in order to send to Azure.

Variables

name (str) – A canonical name for the geographic or physical location. Required.
city (str) – The city or locality where the resource is located.
district (str) – The district, state, or province where the resource is located.
country_or_region (str) – The country or region where the resource is located.

Keyword Arguments

name (str) – A canonical name for the geographic or physical location. Required.
city (str) – The city or locality where the resource is located.
district (str) – The district, state, or province where the resource is located.
country_or_region (str) – The country or region where the resource is located.

class azure.mgmt.apimanagement.models.ResourceSku(*, name: Optional[Union[str, _models.SkuType]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Describes an available API Management SKU.

Variables: name (str or SkuType) – Name of the Sku. Known values are: “Developer”, “Standard”, “Premium”, “Basic”, “Consumption”, and “Isolated”.
Keyword Arguments: name (str or SkuType) – Name of the Sku. Known values are: “Developer”, “Standard”, “Premium”, “Basic”, “Consumption”, and “Isolated”.

class azure.mgmt.apimanagement.models.ResourceSkuCapacity(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Describes scaling information of a SKU.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

minimum (int) – The minimum capacity.
maximum (int) – The maximum capacity that can be set.
default (int) – The default capacity.
scale_type (str or ResourceSkuCapacityScaleType) – The scale type applicable to the sku. Known values are: “automatic”, “manual”, and “none”.

class azure.mgmt.apimanagement.models.ResourceSkuCapacityScaleType(value)[source]¶

Bases: str, enum.Enum

The scale type applicable to the sku.

AUTOMATIC = 'automatic'¶: Supported scale type automatic.

MANUAL = 'manual'¶: Supported scale type manual.

NONE = 'none'¶: Scaling not supported.

class azure.mgmt.apimanagement.models.ResourceSkuResult(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Describes an available API Management service SKU.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

resource_type (str) – The type of resource the SKU applies to.
sku (ResourceSku) – Specifies API Management SKU.
capacity (ResourceSkuCapacity) – Specifies the number of API Management units.

class azure.mgmt.apimanagement.models.ResourceSkuResults(*, value: List[_models.ResourceSkuResult], next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

The API Management service SKUs operation response.

All required parameters must be populated in order to send to Azure.

Variables

value (list[ResourceSkuResult]) – The list of skus available for the service. Required.
next_link (str) – The uri to fetch the next page of API Management service Skus.

Keyword Arguments

value (list[ResourceSkuResult]) – The list of skus available for the service. Required.
next_link (str) – The uri to fetch the next page of API Management service Skus.

class azure.mgmt.apimanagement.models.ResponseContract(*, status_code: int, description: Optional[str] = None, representations: Optional[List[_models.RepresentationContract]] = None, headers: Optional[List[_models.ParameterContract]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Operation response details.

All required parameters must be populated in order to send to Azure.

Variables

status_code (int) – Operation response HTTP status code. Required.
description (str) – Operation response description.
representations (list[RepresentationContract]) – Collection of operation response representations.
headers (list[ParameterContract]) – Collection of operation response headers.

Keyword Arguments

status_code (int) – Operation response HTTP status code. Required.
description (str) – Operation response description.
representations (list[RepresentationContract]) – Collection of operation response representations.
headers (list[ParameterContract]) – Collection of operation response headers.

class azure.mgmt.apimanagement.models.SamplingSettings(*, sampling_type: Optional[Union[str, _models.SamplingType]] = None, percentage: Optional[float] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Sampling settings for Diagnostic.

Variables

sampling_type (str or SamplingType) – Sampling type. “fixed”
percentage (float) – Rate of sampling for fixed-rate sampling.

Keyword Arguments

sampling_type (str or SamplingType) – Sampling type. “fixed”
percentage (float) – Rate of sampling for fixed-rate sampling.

class azure.mgmt.apimanagement.models.SamplingType(value)[source]¶

Bases: str, enum.Enum

Sampling type.

FIXED = 'fixed'¶: Fixed-rate sampling.

class azure.mgmt.apimanagement.models.SaveConfigurationParameter(*, branch: Optional[str] = None, force: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Save Tenant Configuration Contract details.

Variables

branch (str) – The name of the Git branch in which to commit the current configuration snapshot.
force (bool) – The value if true, the current configuration database is committed to the Git repository, even if the Git repository has newer changes that would be overwritten.

Keyword Arguments

branch (str) – The name of the Git branch in which to commit the current configuration snapshot.
force (bool) – The value if true, the current configuration database is committed to the Git repository, even if the Git repository has newer changes that would be overwritten.

class azure.mgmt.apimanagement.models.SchemaCollection(*, count: Optional[int] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

The response of the list schema operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[SchemaContract]) – API Schema Contract value.
count (int) – Total record count number.
next_link (str) – Next page link if any.

Keyword Arguments

count (int) – Total record count number.

class azure.mgmt.apimanagement.models.SchemaContract(*, content_type: Optional[str] = None, value: Optional[str] = None, definitions: Optional[collections.abc.MutableMapping[str, Any]] = None, components: Optional[collections.abc.MutableMapping[str, Any]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

API Schema Contract details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
content_type (str) – Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). - Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schema use application/vnd.ms-azure-apim.xsd+xml - OpenApi Schema use application/vnd.oai.openapi.components+json - WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml.
value (str) – Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
definitions (JSON) – Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.
components (JSON) – Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.

Keyword Arguments

content_type (str) – Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml). - Swagger Schema use application/vnd.ms-azure-apim.swagger.definitions+json - WSDL Schema use application/vnd.ms-azure-apim.xsd+xml - OpenApi Schema use application/vnd.oai.openapi.components+json - WADL Schema use application/vnd.ms-azure-apim.wadl.grammars+xml.
value (str) – Json escaped string defining the document representing the Schema. Used for schemas other than Swagger/OpenAPI.
definitions (JSON) – Types definitions. Used for Swagger/OpenAPI v1 schemas only, null otherwise.
components (JSON) – Types definitions. Used for Swagger/OpenAPI v2/v3 schemas only, null otherwise.

class azure.mgmt.apimanagement.models.SchemaType(value)[source]¶

Bases: str, enum.Enum

Schema Type. Immutable.

JSON = 'json'¶: Json schema type.

XML = 'xml'¶: Xml schema type.

class azure.mgmt.apimanagement.models.SettingsTypeName(value)[source]¶

Bases: str, enum.Enum

SettingsTypeName.

PUBLIC = 'public'¶

class azure.mgmt.apimanagement.models.Severity(value)[source]¶

Bases: str, enum.Enum

The severity of the issue.

ERROR = 'Error'¶

WARNING = 'Warning'¶

class azure.mgmt.apimanagement.models.SkuType(value)[source]¶

Bases: str, enum.Enum

Name of the Sku.

BASIC = 'Basic'¶: Basic SKU of Api Management.

CONSUMPTION = 'Consumption'¶: Consumption SKU of Api Management.

DEVELOPER = 'Developer'¶: Developer SKU of Api Management.

ISOLATED = 'Isolated'¶: Isolated SKU of Api Management.

PREMIUM = 'Premium'¶: Premium SKU of Api Management.

STANDARD = 'Standard'¶: Standard SKU of Api Management.

class azure.mgmt.apimanagement.models.SoapApiType(value)[source]¶

Bases: str, enum.Enum

Type of API to create.

http creates a REST API
soap creates a SOAP pass-through API
websocket creates websocket API
graphql creates GraphQL API.

GRAPH_QL = 'graphql'¶: Imports the API having a GraphQL front end.

SOAP_PASS_THROUGH = 'soap'¶: Imports the SOAP API having a SOAP front end.

SOAP_TO_REST = 'http'¶: Imports a SOAP API having a RESTful front end.

WEB_SOCKET = 'websocket'¶: Imports the API having a Websocket front end.

class azure.mgmt.apimanagement.models.State(value)[source]¶

Bases: str, enum.Enum

Status of the issue.

CLOSED = 'closed'¶: The issue was closed.

OPEN = 'open'¶: The issue is opened.

PROPOSED = 'proposed'¶: The issue is proposed.

REMOVED = 'removed'¶: The issue was removed.

RESOLVED = 'resolved'¶: The issue is now resolved.

class azure.mgmt.apimanagement.models.SubscriptionCollection(*, value: Optional[List[_models.SubscriptionContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Subscriptions list representation.

Variables

value (list[SubscriptionContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[SubscriptionContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.SubscriptionContract(*, owner_id: Optional[str] = None, scope: Optional[str] = None, display_name: Optional[str] = None, state: Optional[Union[str, _models.SubscriptionState]] = None, start_date: Optional[datetime.datetime] = None, expiration_date: Optional[datetime.datetime] = None, end_date: Optional[datetime.datetime] = None, notification_date: Optional[datetime.datetime] = None, primary_key: Optional[str] = None, secondary_key: Optional[str] = None, state_comment: Optional[str] = None, allow_tracing: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Subscription details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
owner_id (str) – The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier.
scope (str) – Scope like /products/{productId} or /apis or /apis/{apiId}.
display_name (str) – The name of the subscription, or null if the subscription has no name.
state (str or SubscriptionState) – Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. Known values are: “suspended”, “active”, “expired”, “submitted”, “rejected”, and “cancelled”.
created_date (datetime) – Subscription creation date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
start_date (datetime) – Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the state property. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
expiration_date (datetime) – Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the state property. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
end_date (datetime) – Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the state property. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
notification_date (datetime) – Upcoming subscription expiration notification date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
primary_key (str) – Subscription primary key. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
secondary_key (str) – Subscription secondary key. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
state_comment (str) – Optional subscription comment added by an administrator when the state is changed to the ‘rejected’.
allow_tracing (bool) – Determines whether tracing is enabled.

Keyword Arguments

owner_id (str) – The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{userId} where {userId} is a user identifier.
scope (str) – Scope like /products/{productId} or /apis or /apis/{apiId}.
display_name (str) – The name of the subscription, or null if the subscription has no name.
state (str or SubscriptionState) – Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. Known values are: “suspended”, “active”, “expired”, “submitted”, “rejected”, and “cancelled”.
start_date (datetime) – Subscription activation date. The setting is for audit purposes only and the subscription is not automatically activated. The subscription lifecycle can be managed by using the state property. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
expiration_date (datetime) – Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the state property. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
end_date (datetime) – Date when subscription was cancelled or expired. The setting is for audit purposes only and the subscription is not automatically cancelled. The subscription lifecycle can be managed by using the state property. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
notification_date (datetime) – Upcoming subscription expiration notification date. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
primary_key (str) – Subscription primary key. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
secondary_key (str) – Subscription secondary key. This property will not be filled on ‘GET’ operations! Use ‘/listSecrets’ POST request to get the value.
state_comment (str) – Optional subscription comment added by an administrator when the state is changed to the ‘rejected’.
allow_tracing (bool) – Determines whether tracing is enabled.

class azure.mgmt.apimanagement.models.SubscriptionCreateParameters(*, owner_id: Optional[str] = None, scope: Optional[str] = None, display_name: Optional[str] = None, primary_key: Optional[str] = None, secondary_key: Optional[str] = None, state: Optional[Union[str, _models.SubscriptionState]] = None, allow_tracing: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Subscription create details.

Variables

owner_id (str) – User (user id path) for whom subscription is being created in form /users/{userId}.
scope (str) – Scope like /products/{productId} or /apis or /apis/{apiId}.
display_name (str) – Subscription name.
primary_key (str) – Primary subscription key. If not specified during request key will be generated automatically.
secondary_key (str) – Secondary subscription key. If not specified during request key will be generated automatically.
state (str or SubscriptionState) – Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. Known values are: “suspended”, “active”, “expired”, “submitted”, “rejected”, and “cancelled”.
allow_tracing (bool) – Determines whether tracing can be enabled.

Keyword Arguments

owner_id (str) – User (user id path) for whom subscription is being created in form /users/{userId}.
scope (str) – Scope like /products/{productId} or /apis or /apis/{apiId}.
display_name (str) – Subscription name.
primary_key (str) – Primary subscription key. If not specified during request key will be generated automatically.
secondary_key (str) – Secondary subscription key. If not specified during request key will be generated automatically.
state (str or SubscriptionState) – Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. Known values are: “suspended”, “active”, “expired”, “submitted”, “rejected”, and “cancelled”.
allow_tracing (bool) – Determines whether tracing can be enabled.

class azure.mgmt.apimanagement.models.SubscriptionKeyParameterNamesContract(*, header: Optional[str] = None, query: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Subscription key parameter names details.

Variables

header (str) – Subscription key header name.
query (str) – Subscription key query string parameter name.

Keyword Arguments

header (str) – Subscription key header name.
query (str) – Subscription key query string parameter name.

class azure.mgmt.apimanagement.models.SubscriptionKeysContract(*, primary_key: Optional[str] = None, secondary_key: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Subscription keys.

Variables

primary_key (str) – Subscription primary key.
secondary_key (str) – Subscription secondary key.

Keyword Arguments

primary_key (str) – Subscription primary key.
secondary_key (str) – Subscription secondary key.

class azure.mgmt.apimanagement.models.SubscriptionState(value)[source]¶

Bases: str, enum.Enum

Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated.

ACTIVE = 'active'¶

CANCELLED = 'cancelled'¶

EXPIRED = 'expired'¶

REJECTED = 'rejected'¶

SUBMITTED = 'submitted'¶

SUSPENDED = 'suspended'¶

class azure.mgmt.apimanagement.models.SubscriptionUpdateParameters(*, owner_id: Optional[str] = None, scope: Optional[str] = None, expiration_date: Optional[datetime.datetime] = None, display_name: Optional[str] = None, primary_key: Optional[str] = None, secondary_key: Optional[str] = None, state: Optional[Union[str, _models.SubscriptionState]] = None, state_comment: Optional[str] = None, allow_tracing: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Subscription update details.

Variables

owner_id (str) – User identifier path: /users/{userId}.
scope (str) – Scope like /products/{productId} or /apis or /apis/{apiId}.
expiration_date (datetime) – Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the state property. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
display_name (str) – Subscription name.
primary_key (str) – Primary subscription key.
secondary_key (str) – Secondary subscription key.
state (str or SubscriptionState) – Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. Known values are: “suspended”, “active”, “expired”, “submitted”, “rejected”, and “cancelled”.
state_comment (str) – Comments describing subscription state change by the administrator when the state is changed to the ‘rejected’.
allow_tracing (bool) – Determines whether tracing can be enabled.

Keyword Arguments

owner_id (str) – User identifier path: /users/{userId}.
scope (str) – Scope like /products/{productId} or /apis or /apis/{apiId}.
expiration_date (datetime) – Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the state property. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
display_name (str) – Subscription name.
primary_key (str) – Primary subscription key.
secondary_key (str) – Secondary subscription key.
state (str or SubscriptionState) – Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. Known values are: “suspended”, “active”, “expired”, “submitted”, “rejected”, and “cancelled”.
state_comment (str) – Comments describing subscription state change by the administrator when the state is changed to the ‘rejected’.
allow_tracing (bool) – Determines whether tracing can be enabled.

class azure.mgmt.apimanagement.models.SubscriptionsDelegationSettingsProperties(*, enabled: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Subscriptions delegation settings properties.

Variables: enabled (bool) – Enable or disable delegation for subscriptions.
Keyword Arguments: enabled (bool) – Enable or disable delegation for subscriptions.

class azure.mgmt.apimanagement.models.SystemData(*, created_by: Optional[str] = None, created_by_type: Optional[Union[str, _models.CreatedByType]] = None, created_at: Optional[datetime.datetime] = None, last_modified_by: Optional[str] = None, last_modified_by_type: Optional[Union[str, _models.CreatedByType]] = None, last_modified_at: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Metadata pertaining to creation and last modification of the resource.

Variables

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

Keyword Arguments

created_by (str) – The identity that created the resource.
created_by_type (str or CreatedByType) – The type of identity that created the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
created_at (datetime) – The timestamp of resource creation (UTC).
last_modified_by (str) – The identity that last modified the resource.
last_modified_by_type (str or CreatedByType) – The type of identity that last modified the resource. Known values are: “User”, “Application”, “ManagedIdentity”, and “Key”.
last_modified_at (datetime) – The timestamp of resource last modification (UTC).

class azure.mgmt.apimanagement.models.TagCollection(*, value: Optional[List[_models.TagContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Tag list representation.

Variables

value (list[TagContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[TagContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.TagContract(*, display_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Tag Contract details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
display_name (str) – Tag name.

Keyword Arguments

display_name (str) – Tag name.

class azure.mgmt.apimanagement.models.TagCreateUpdateParameters(*, display_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Parameters supplied to Create/Update Tag operations.

Variables: display_name (str) – Tag name.
Keyword Arguments: display_name (str) – Tag name.

class azure.mgmt.apimanagement.models.TagDescriptionBaseProperties(*, description: Optional[str] = None, external_docs_url: Optional[str] = None, external_docs_description: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Parameters supplied to the Create TagDescription operation.

Variables

description (str) – Description of the Tag.
external_docs_url (str) – Absolute URL of external resources describing the tag.
external_docs_description (str) – Description of the external resources describing the tag.

Keyword Arguments

description (str) – Description of the Tag.
external_docs_url (str) – Absolute URL of external resources describing the tag.
external_docs_description (str) – Description of the external resources describing the tag.

class azure.mgmt.apimanagement.models.TagDescriptionCollection(*, value: Optional[List[_models.TagDescriptionContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged TagDescription list representation.

Variables

value (list[TagDescriptionContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[TagDescriptionContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.TagDescriptionContract(*, description: Optional[str] = None, external_docs_url: Optional[str] = None, external_docs_description: Optional[str] = None, tag_id: Optional[str] = None, display_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Contract details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
description (str) – Description of the Tag.
external_docs_url (str) – Absolute URL of external resources describing the tag.
external_docs_description (str) – Description of the external resources describing the tag.
tag_id (str) – Identifier of the tag in the form of /tags/{tagId}.
display_name (str) – Tag name.

Keyword Arguments

description (str) – Description of the Tag.
external_docs_url (str) – Absolute URL of external resources describing the tag.
external_docs_description (str) – Description of the external resources describing the tag.
tag_id (str) – Identifier of the tag in the form of /tags/{tagId}.
display_name (str) – Tag name.

class azure.mgmt.apimanagement.models.TagDescriptionContractProperties(*, description: Optional[str] = None, external_docs_url: Optional[str] = None, external_docs_description: Optional[str] = None, tag_id: Optional[str] = None, display_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.TagDescriptionBaseProperties

TagDescription contract Properties.

Variables

description (str) – Description of the Tag.
external_docs_url (str) – Absolute URL of external resources describing the tag.
external_docs_description (str) – Description of the external resources describing the tag.
tag_id (str) – Identifier of the tag in the form of /tags/{tagId}.
display_name (str) – Tag name.

Keyword Arguments

description (str) – Description of the Tag.
external_docs_url (str) – Absolute URL of external resources describing the tag.
external_docs_description (str) – Description of the external resources describing the tag.
tag_id (str) – Identifier of the tag in the form of /tags/{tagId}.
display_name (str) – Tag name.

class azure.mgmt.apimanagement.models.TagDescriptionCreateParameters(*, description: Optional[str] = None, external_docs_url: Optional[str] = None, external_docs_description: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Parameters supplied to the Create TagDescription operation.

Variables

description (str) – Description of the Tag.
external_docs_url (str) – Absolute URL of external resources describing the tag.
external_docs_description (str) – Description of the external resources describing the tag.

Keyword Arguments

description (str) – Description of the Tag.
external_docs_url (str) – Absolute URL of external resources describing the tag.
external_docs_description (str) – Description of the external resources describing the tag.

class azure.mgmt.apimanagement.models.TagResourceCollection(*, value: Optional[List[_models.TagResourceContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Tag list representation.

Variables

value (list[TagResourceContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[TagResourceContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.TagResourceContract(*, tag: _models.TagResourceContractProperties, api: Optional[_models.ApiTagResourceContractProperties] = None, operation: Optional[_models.OperationTagResourceContractProperties] = None, product: Optional[_models.ProductTagResourceContractProperties] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

TagResource contract properties.

All required parameters must be populated in order to send to Azure.

Variables

tag (TagResourceContractProperties) – Tag associated with the resource. Required.
api (ApiTagResourceContractProperties) – API associated with the tag.
operation (OperationTagResourceContractProperties) – Operation associated with the tag.
product (ProductTagResourceContractProperties) – Product associated with the tag.

Keyword Arguments

tag (TagResourceContractProperties) – Tag associated with the resource. Required.
api (ApiTagResourceContractProperties) – API associated with the tag.
operation (OperationTagResourceContractProperties) – Operation associated with the tag.
product (ProductTagResourceContractProperties) – Product associated with the tag.

class azure.mgmt.apimanagement.models.TagResourceContractProperties(*, id: Optional[str] = None, name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Contract defining the Tag property in the Tag Resource Contract.

Variables

id (str) – Tag identifier.
name (str) – Tag Name.

Keyword Arguments

id (str) – Tag identifier.
name (str) – Tag Name.

class azure.mgmt.apimanagement.models.TemplateName(value)[source]¶

Bases: str, enum.Enum

TemplateName.

ACCOUNT_CLOSED_DEVELOPER = 'accountClosedDeveloper'¶

APPLICATION_APPROVED_NOTIFICATION_MESSAGE = 'applicationApprovedNotificationMessage'¶

CONFIRM_SIGN_UP_IDENTITY_DEFAULT = 'confirmSignUpIdentityDefault'¶

EMAIL_CHANGE_IDENTITY_DEFAULT = 'emailChangeIdentityDefault'¶

INVITE_USER_NOTIFICATION_MESSAGE = 'inviteUserNotificationMessage'¶

NEW_COMMENT_NOTIFICATION_MESSAGE = 'newCommentNotificationMessage'¶

NEW_DEVELOPER_NOTIFICATION_MESSAGE = 'newDeveloperNotificationMessage'¶

NEW_ISSUE_NOTIFICATION_MESSAGE = 'newIssueNotificationMessage'¶

PASSWORD_RESET_BY_ADMIN_NOTIFICATION_MESSAGE = 'passwordResetByAdminNotificationMessage'¶

PASSWORD_RESET_IDENTITY_DEFAULT = 'passwordResetIdentityDefault'¶

PURCHASE_DEVELOPER_NOTIFICATION_MESSAGE = 'purchaseDeveloperNotificationMessage'¶

QUOTA_LIMIT_APPROACHING_DEVELOPER_NOTIFICATION_MESSAGE = 'quotaLimitApproachingDeveloperNotificationMessage'¶

REJECT_DEVELOPER_NOTIFICATION_MESSAGE = 'rejectDeveloperNotificationMessage'¶

REQUEST_DEVELOPER_NOTIFICATION_MESSAGE = 'requestDeveloperNotificationMessage'¶

class azure.mgmt.apimanagement.models.TenantConfigurationSyncStateContract(*, branch: Optional[str] = None, commit_id: Optional[str] = None, is_export: Optional[bool] = None, is_synced: Optional[bool] = None, is_git_enabled: Optional[bool] = None, sync_date: Optional[datetime.datetime] = None, configuration_change_date: Optional[datetime.datetime] = None, last_operation_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Result of Tenant Configuration Sync State.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
branch (str) – The name of Git branch.
commit_id (str) – The latest commit Id.
is_export (bool) – value indicating if last sync was save (true) or deploy (false) operation.
is_synced (bool) – value indicating if last synchronization was later than the configuration change.
is_git_enabled (bool) – value indicating whether Git configuration access is enabled.
sync_date (datetime) – The date of the latest synchronization. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
configuration_change_date (datetime) – The date of the latest configuration change. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
last_operation_id (str) – Most recent tenant configuration operation identifier.

Keyword Arguments

branch (str) – The name of Git branch.
commit_id (str) – The latest commit Id.
is_export (bool) – value indicating if last sync was save (true) or deploy (false) operation.
is_synced (bool) – value indicating if last synchronization was later than the configuration change.
is_git_enabled (bool) – value indicating whether Git configuration access is enabled.
sync_date (datetime) – The date of the latest synchronization. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
configuration_change_date (datetime) – The date of the latest configuration change. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
last_operation_id (str) – Most recent tenant configuration operation identifier.

class azure.mgmt.apimanagement.models.TenantSettingsCollection(**kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged AccessInformation list representation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

value (list[TenantSettingsContract]) – Page values.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.TenantSettingsContract(*, settings: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

Tenant Settings.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
settings (dict[str, str]) – Tenant settings.

Keyword Arguments

settings (dict[str, str]) – Tenant settings.

class azure.mgmt.apimanagement.models.TermsOfServiceProperties(*, text: Optional[str] = None, enabled: Optional[bool] = None, consent_required: Optional[bool] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Terms of service contract properties.

Variables

text (str) – A terms of service text.
enabled (bool) – Display terms of service during a sign-up process.
consent_required (bool) – Ask user for consent to the terms of service.

Keyword Arguments

text (str) – A terms of service text.
enabled (bool) – Display terms of service during a sign-up process.
consent_required (bool) – Ask user for consent to the terms of service.

class azure.mgmt.apimanagement.models.TokenBodyParameterContract(*, name: str, value: str, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

OAuth acquire token request body parameter (www-url-form-encoded).

All required parameters must be populated in order to send to Azure.

Variables

name (str) – body parameter name. Required.
value (str) – body parameter value. Required.

Keyword Arguments

name (str) – body parameter name. Required.
value (str) – body parameter value. Required.

class azure.mgmt.apimanagement.models.UserCollection(*, value: Optional[List[_models.UserContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Paged Users list representation.

Variables

value (list[UserContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[UserContract]) – Page values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.UserContract(*, state: Union[str, _models.UserState] = 'active', note: Optional[str] = None, identities: Optional[List[_models.UserIdentityContract]] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, email: Optional[str] = None, registration_date: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.Resource

User details.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name (str) – The name of the resource.
type (str) – The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”.
state (str or UserState) – Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Known values are: “active”, “blocked”, “pending”, and “deleted”.
note (str) – Optional note about a user set by the administrator.
identities (list[UserIdentityContract]) – Collection of user identities.
first_name (str) – First name.
last_name (str) – Last name.
email (str) – Email address.
registration_date (datetime) – Date of user registration. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
groups (list[GroupContractProperties]) – Collection of groups user is part of.

Keyword Arguments

state (str or UserState) – Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Known values are: “active”, “blocked”, “pending”, and “deleted”.
note (str) – Optional note about a user set by the administrator.
identities (list[UserIdentityContract]) – Collection of user identities.
first_name (str) – First name.
last_name (str) – Last name.
email (str) – Email address.
registration_date (datetime) – Date of user registration. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

class azure.mgmt.apimanagement.models.UserContractProperties(*, state: Union[str, _models.UserState] = 'active', note: Optional[str] = None, identities: Optional[List[_models.UserIdentityContract]] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, email: Optional[str] = None, registration_date: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.UserEntityBaseParameters

User profile.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

state (str or UserState) – Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Known values are: “active”, “blocked”, “pending”, and “deleted”.
note (str) – Optional note about a user set by the administrator.
identities (list[UserIdentityContract]) – Collection of user identities.
first_name (str) – First name.
last_name (str) – Last name.
email (str) – Email address.
registration_date (datetime) – Date of user registration. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
groups (list[GroupContractProperties]) – Collection of groups user is part of.

Keyword Arguments

state (str or UserState) – Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Known values are: “active”, “blocked”, “pending”, and “deleted”.
note (str) – Optional note about a user set by the administrator.
identities (list[UserIdentityContract]) – Collection of user identities.
first_name (str) – First name.
last_name (str) – Last name.
email (str) – Email address.
registration_date (datetime) – Date of user registration. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

class azure.mgmt.apimanagement.models.UserCreateParameterProperties(*, email: str, first_name: str, last_name: str, state: Union[str, _models.UserState] = 'active', note: Optional[str] = None, identities: Optional[List[_models.UserIdentityContract]] = None, password: Optional[str] = None, app_type: Optional[Union[str, _models.AppType]] = None, confirmation: Optional[Union[str, _models.Confirmation]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.UserEntityBaseParameters

Parameters supplied to the Create User operation.

All required parameters must be populated in order to send to Azure.

Variables

state (str or UserState) – Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Known values are: “active”, “blocked”, “pending”, and “deleted”.
note (str) – Optional note about a user set by the administrator.
identities (list[UserIdentityContract]) – Collection of user identities.
email (str) – Email address. Must not be empty and must be unique within the service instance. Required.
first_name (str) – First name. Required.
last_name (str) – Last name. Required.
password (str) – User Password. If no value is provided, a default password is generated.
app_type (str or AppType) – Determines the type of application which send the create user request. Default is legacy portal. Known values are: “portal” and “developerPortal”.
confirmation (str or Confirmation) – Determines the type of confirmation e-mail that will be sent to the newly created user. Known values are: “signup” and “invite”.

Keyword Arguments

state (str or UserState) – Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Known values are: “active”, “blocked”, “pending”, and “deleted”.
note (str) – Optional note about a user set by the administrator.
identities (list[UserIdentityContract]) – Collection of user identities.
email (str) – Email address. Must not be empty and must be unique within the service instance. Required.
first_name (str) – First name. Required.
last_name (str) – Last name. Required.
password (str) – User Password. If no value is provided, a default password is generated.
app_type (str or AppType) – Determines the type of application which send the create user request. Default is legacy portal. Known values are: “portal” and “developerPortal”.
confirmation (str or Confirmation) – Determines the type of confirmation e-mail that will be sent to the newly created user. Known values are: “signup” and “invite”.

class azure.mgmt.apimanagement.models.UserCreateParameters(*, state: Union[str, _models.UserState] = 'active', note: Optional[str] = None, identities: Optional[List[_models.UserIdentityContract]] = None, email: Optional[str] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, password: Optional[str] = None, app_type: Optional[Union[str, _models.AppType]] = None, confirmation: Optional[Union[str, _models.Confirmation]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

User create details.

Variables

state (str or UserState) – Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Known values are: “active”, “blocked”, “pending”, and “deleted”.
note (str) – Optional note about a user set by the administrator.
identities (list[UserIdentityContract]) – Collection of user identities.
email (str) – Email address. Must not be empty and must be unique within the service instance.
first_name (str) – First name.
last_name (str) – Last name.
password (str) – User Password. If no value is provided, a default password is generated.
app_type (str or AppType) – Determines the type of application which send the create user request. Default is legacy portal. Known values are: “portal” and “developerPortal”.
confirmation (str or Confirmation) – Determines the type of confirmation e-mail that will be sent to the newly created user. Known values are: “signup” and “invite”.

Keyword Arguments

state (str or UserState) – Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Known values are: “active”, “blocked”, “pending”, and “deleted”.
note (str) – Optional note about a user set by the administrator.
identities (list[UserIdentityContract]) – Collection of user identities.
email (str) – Email address. Must not be empty and must be unique within the service instance.
first_name (str) – First name.
last_name (str) – Last name.
password (str) – User Password. If no value is provided, a default password is generated.
app_type (str or AppType) – Determines the type of application which send the create user request. Default is legacy portal. Known values are: “portal” and “developerPortal”.
confirmation (str or Confirmation) – Determines the type of confirmation e-mail that will be sent to the newly created user. Known values are: “signup” and “invite”.

class azure.mgmt.apimanagement.models.UserEntityBaseParameters(*, state: Union[str, _models.UserState] = 'active', note: Optional[str] = None, identities: Optional[List[_models.UserIdentityContract]] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

User Entity Base Parameters set.

Variables

state (str or UserState) – Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Known values are: “active”, “blocked”, “pending”, and “deleted”.
note (str) – Optional note about a user set by the administrator.
identities (list[UserIdentityContract]) – Collection of user identities.

Keyword Arguments

state (str or UserState) – Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Known values are: “active”, “blocked”, “pending”, and “deleted”.
note (str) – Optional note about a user set by the administrator.
identities (list[UserIdentityContract]) – Collection of user identities.

class azure.mgmt.apimanagement.models.UserIdentityCollection(*, value: Optional[List[_models.UserIdentityContract]] = None, count: Optional[int] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

List of Users Identity list representation.

Variables

value (list[UserIdentityContract]) – User Identity values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

Keyword Arguments

value (list[UserIdentityContract]) – User Identity values.
count (int) – Total record count number across all pages.
next_link (str) – Next page link if any.

class azure.mgmt.apimanagement.models.UserIdentityContract(*, provider: Optional[str] = None, id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

User identity details.

Variables

provider (str) – Identity provider name.
id (str) – Identifier value within provider.

Keyword Arguments

provider (str) – Identity provider name.
id (str) – Identifier value within provider.

class azure.mgmt.apimanagement.models.UserIdentityProperties(*, principal_id: Optional[str] = None, client_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

UserIdentityProperties.

Variables

principal_id (str) – The principal id of user assigned identity.
client_id (str) – The client id of user assigned identity.

Keyword Arguments

principal_id (str) – The principal id of user assigned identity.
client_id (str) – The client id of user assigned identity.

class azure.mgmt.apimanagement.models.UserState(value)[source]¶

Bases: str, enum.Enum

Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active.

ACTIVE = 'active'¶: User state is active.

BLOCKED = 'blocked'¶: User is blocked. Blocked users cannot authenticate at developer portal or call API.

DELETED = 'deleted'¶: User account is closed. All identities and related entities are removed.

PENDING = 'pending'¶: User account is pending. Requires identity confirmation before it can be made active.

class azure.mgmt.apimanagement.models.UserTokenParameters(*, key_type: Optional[Union[str, _models.KeyType]] = None, expiry: Optional[datetime.datetime] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Get User Token parameters.

Variables

key_type (str or KeyType) – The Key to be used to generate token for user. Known values are: “primary” and “secondary”.
expiry (datetime) – The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

Keyword Arguments

key_type (str or KeyType) – The Key to be used to generate token for user. Known values are: “primary” and “secondary”.
expiry (datetime) – The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

class azure.mgmt.apimanagement.models.UserTokenResult(*, value: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Get User Token response details.

Variables: value (str) – Shared Access Authorization token for the User.
Keyword Arguments: value (str) – Shared Access Authorization token for the User.

class azure.mgmt.apimanagement.models.UserUpdateParameters(*, state: Union[str, _models.UserState] = 'active', note: Optional[str] = None, identities: Optional[List[_models.UserIdentityContract]] = None, email: Optional[str] = None, password: Optional[str] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

User update parameters.

Variables

state (str or UserState) – Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Known values are: “active”, “blocked”, “pending”, and “deleted”.
note (str) – Optional note about a user set by the administrator.
identities (list[UserIdentityContract]) – Collection of user identities.
email (str) – Email address. Must not be empty and must be unique within the service instance.
password (str) – User Password.
first_name (str) – First name.
last_name (str) – Last name.

Keyword Arguments

state (str or UserState) – Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Known values are: “active”, “blocked”, “pending”, and “deleted”.
note (str) – Optional note about a user set by the administrator.
identities (list[UserIdentityContract]) – Collection of user identities.
email (str) – Email address. Must not be empty and must be unique within the service instance.
password (str) – User Password.
first_name (str) – First name.
last_name (str) – Last name.

class azure.mgmt.apimanagement.models.UserUpdateParametersProperties(*, state: Union[str, _models.UserState] = 'active', note: Optional[str] = None, identities: Optional[List[_models.UserIdentityContract]] = None, email: Optional[str] = None, password: Optional[str] = None, first_name: Optional[str] = None, last_name: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement.models._models_py3.UserEntityBaseParameters

Parameters supplied to the Update User operation.

Variables

state (str or UserState) – Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Known values are: “active”, “blocked”, “pending”, and “deleted”.
note (str) – Optional note about a user set by the administrator.
identities (list[UserIdentityContract]) – Collection of user identities.
email (str) – Email address. Must not be empty and must be unique within the service instance.
password (str) – User Password.
first_name (str) – First name.
last_name (str) – Last name.

Keyword Arguments

state (str or UserState) – Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. Known values are: “active”, “blocked”, “pending”, and “deleted”.
note (str) – Optional note about a user set by the administrator.
identities (list[UserIdentityContract]) – Collection of user identities.
email (str) – Email address. Must not be empty and must be unique within the service instance.
password (str) – User Password.
first_name (str) – First name.
last_name (str) – Last name.

class azure.mgmt.apimanagement.models.Verbosity(value)[source]¶

Bases: str, enum.Enum

The verbosity level applied to traces emitted by trace policies.

ERROR = 'error'¶: Only traces with ‘severity’ set to ‘error’ will be sent to the logger attached to this diagnostic instance.

INFORMATION = 'information'¶: Traces with ‘severity’ set to ‘information’ and ‘error’ will be sent to the logger attached to this diagnostic instance.

VERBOSE = 'verbose'¶: All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.

class azure.mgmt.apimanagement.models.VersioningScheme(value)[source]¶

Bases: str, enum.Enum

An value that determines where the API Version identifier will be located in a HTTP request.

HEADER = 'Header'¶: The API Version is passed in a HTTP header.

QUERY = 'Query'¶: The API Version is passed in a query parameter.

SEGMENT = 'Segment'¶: The API Version is passed in a path segment.

class azure.mgmt.apimanagement.models.VirtualNetworkConfiguration(*, subnet_resource_id: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Configuration of a virtual network to which API Management service is deployed.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

vnetid (str) – The virtual network ID. This is typically a GUID. Expect a null GUID by default.
subnetname (str) – The name of the subnet.
subnet_resource_id (str) – The full resource ID of a subnet in a virtual network to deploy the API Management service in.

Keyword Arguments

subnet_resource_id (str) – The full resource ID of a subnet in a virtual network to deploy the API Management service in.

class azure.mgmt.apimanagement.models.VirtualNetworkType(value)[source]¶

Bases: str, enum.Enum

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.

EXTERNAL = 'External'¶: The service is part of Virtual Network and it is accessible from Internet.

INTERNAL = 'Internal'¶: The service is part of Virtual Network and it is only accessible from within the virtual network.

NONE = 'None'¶: The service is not part of any Virtual Network.

class azure.mgmt.apimanagement.models.X509CertificateName(*, name: Optional[str] = None, issuer_certificate_thumbprint: Optional[str] = None, **kwargs)[source]¶

Bases: azure.mgmt.apimanagement._serialization.Model

Properties of server X509Names.

Variables

name (str) – Common Name of the Certificate.
issuer_certificate_thumbprint (str) – Thumbprint for the Issuer of the Certificate.

Keyword Arguments

name (str) – Common Name of the Certificate.
issuer_certificate_thumbprint (str) – Thumbprint for the Issuer of the Certificate.