azure.mgmt.apimanagement.operations module¶

delete(resource_group_name: str, service_name: str, api_id: str, if_match: str, delete_revisions: Optional[bool] = None, **kwargs: Any) → None [source]¶

Deletes the specified API of the API Management service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
delete_revisions (bool) – Delete all revisions of the Api.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, api_id: str, **kwargs: Any) → ’_models.ApiContract’[source]¶

Gets the details of the API specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ApiContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the API specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, tags: Optional[str] = None, expand_api_version_set: Optional[bool] = None, **kwargs: Any) → Iterable[‘_models.ApiCollection’][source]¶

Lists all APIs of the API Management service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || isCurrent | filter | eq, ne | |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.
tags (str) – Include tags in the response.
expand_api_version_set (bool) – Include full ApiVersionSet resource in response.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ApiCollection or the result of cls(response)

Return type

ItemPaged[ApiCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_tags(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, include_not_tagged_apis: Optional[bool] = None, **kwargs: Any) → Iterable[‘_models.TagResourceCollection’][source]¶

Lists a collection of apis associated with tags.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || isCurrent | filter | eq | |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.
include_not_tagged_apis (bool) – Include not tagged APIs.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TagResourceCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, api_id: str, if_match: str, parameters: ‘_models.ApiUpdateContract’, **kwargs: Any) → ’_models.ApiContract’[source]¶

Updates the specified API of the API Management service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (ApiUpdateContract) – API Update Contract parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ApiContract, or the result of cls(response)

Return type

ItemPaged[ApiRevisionCollection]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ApiRevisionOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ApiRevisionOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list_by_service(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.ApiRevisionCollection’][source]¶

Lists all revisions of an API.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ApiRevisionCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ApiReleaseOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ApiReleaseOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, api_id: str, release_id: str, parameters: ‘_models.ApiReleaseContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.ApiReleaseContract’[source]¶

Creates a new Release for the API.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
release_id (str) – Release identifier within an API. Must be unique in the current API Management service instance.
parameters (ApiReleaseContract) – Create parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ApiReleaseContract, or the result of cls(response)

Return type

ApiReleaseContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, api_id: str, release_id: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes the specified release in the API.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
release_id (str) – Release identifier within an API. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, api_id: str, release_id: str, **kwargs: Any) → ’_models.ApiReleaseContract’[source]¶

Returns the details of an API release.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
release_id (str) – Release identifier within an API. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ApiReleaseContract, or the result of cls(response)

Return type

ApiReleaseContract

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, release_id: str, **kwargs: Any) → bool [source]¶

Returns the etag of an API release.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
release_id (str) – Release identifier within an API. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[ApiReleaseCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.ApiReleaseCollection’][source]¶

Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| notes | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ApiReleaseCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, api_id: str, release_id: str, if_match: str, parameters: ‘_models.ApiReleaseContract’, **kwargs: Any) → ’_models.ApiReleaseContract’[source]¶

Updates the details of the release of the API specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
release_id (str) – Release identifier within an API. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (ApiReleaseContract) – API Release Update parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ApiReleaseContract, or the result of cls(response)

Return type

ApiReleaseContract

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ApiOperationOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ApiOperationOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, api_id: str, operation_id: str, parameters: ‘_models.OperationContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.OperationContract’[source]¶

Creates a new operation in the API or updates an existing one.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance.
parameters (OperationContract) – Create parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

OperationContract, or the result of cls(response)

Return type

OperationContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, api_id: str, operation_id: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes the specified operation in the API.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, api_id: str, operation_id: str, **kwargs: Any) → ’_models.OperationContract’[source]¶

Gets the details of the API Operation specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

OperationContract, or the result of cls(response)

Return type

OperationContract

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, operation_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the API operation specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[OperationCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_api(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, tags: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.OperationCollection’][source]¶

Lists a collection of the operations for the specified API.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.
tags (str) – Include tags in the response.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either OperationCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, api_id: str, operation_id: str, if_match: str, parameters: ‘_models.OperationUpdateContract’, **kwargs: Any) → ’_models.OperationContract’[source]¶

Updates the details of the operation in the API specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (OperationUpdateContract) – API Operation Update parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

OperationContract, or the result of cls(response)

Return type

OperationContract

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ApiOperationPolicyOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ApiOperationPolicyOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, api_id: str, operation_id: str, policy_id: Union[str, ‘_models.PolicyIdName’], parameters: ‘_models.PolicyContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.PolicyContract’[source]¶

Creates or updates policy configuration for the API Operation level.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance.
policy_id (str or PolicyIdName) – The identifier of the Policy.
parameters (PolicyContract) – The policy contents to apply.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PolicyContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, api_id: str, operation_id: str, policy_id: Union[str, ‘_models.PolicyIdName’], if_match: str, **kwargs: Any) → None [source]¶

Deletes the policy configuration at the Api Operation.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance.
policy_id (str or PolicyIdName) – The identifier of the Policy.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, api_id: str, operation_id: str, policy_id: Union[str, ‘_models.PolicyIdName’], format: Optional[Union[str, ‘_models.PolicyExportFormat’]] = 'xml', **kwargs: Any) → ’_models.PolicyContract’[source]¶

Get the policy configuration at the API Operation level.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance.
policy_id (str or PolicyIdName) – The identifier of the Policy.
format (str or PolicyExportFormat) – Policy Export Format.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PolicyContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, operation_id: str, policy_id: Union[str, ‘_models.PolicyIdName’], **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the API operation policy specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance.
policy_id (str or PolicyIdName) – The identifier of the Policy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_operation(resource_group_name: str, service_name: str, api_id: str, operation_id: str, **kwargs: Any) → ’_models.PolicyCollection’[source]¶

Get the list of policy configuration at the API Operation level.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PolicyCollection, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.TagOperations(client, config, serializer, deserializer)[source]¶

Bases: object

TagOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

assign_to_api(resource_group_name: str, service_name: str, api_id: str, tag_id: str, **kwargs: Any) → ’_models.TagContract’[source]¶

Assign tag to the Api.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
tag_id (str) – Tag identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TagContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

assign_to_operation(resource_group_name: str, service_name: str, api_id: str, operation_id: str, tag_id: str, **kwargs: Any) → ’_models.TagContract’[source]¶

Assign tag to the Operation.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance.
tag_id (str) – Tag identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TagContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

assign_to_product(resource_group_name: str, service_name: str, product_id: str, tag_id: str, **kwargs: Any) → ’_models.TagContract’[source]¶

Assign tag to the Product.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
tag_id (str) – Tag identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TagContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

create_or_update(resource_group_name: str, service_name: str, tag_id: str, parameters: ‘_models.TagCreateUpdateParameters’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.TagContract’[source]¶

Creates a tag.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
tag_id (str) – Tag identifier. Must be unique in the current API Management service instance.
parameters (TagCreateUpdateParameters) – Create parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TagContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, tag_id: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes specific tag of the API Management service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
tag_id (str) – Tag identifier. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

detach_from_api(resource_group_name: str, service_name: str, api_id: str, tag_id: str, **kwargs: Any) → None [source]¶

Detach the tag from the Api.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
tag_id (str) – Tag identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

detach_from_operation(resource_group_name: str, service_name: str, api_id: str, operation_id: str, tag_id: str, **kwargs: Any) → None [source]¶

Detach the tag from the Operation.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance.
tag_id (str) – Tag identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

detach_from_product(resource_group_name: str, service_name: str, product_id: str, tag_id: str, **kwargs: Any) → None [source]¶

Detach the tag from the Product.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
tag_id (str) – Tag identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, tag_id: str, **kwargs: Any) → ’_models.TagContract’[source]¶

Gets the details of the tag specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
tag_id (str) – Tag identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TagContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_by_api(resource_group_name: str, service_name: str, api_id: str, tag_id: str, **kwargs: Any) → ’_models.TagContract’[source]¶

Get tag associated with the API.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
tag_id (str) – Tag identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TagContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_by_operation(resource_group_name: str, service_name: str, api_id: str, operation_id: str, tag_id: str, **kwargs: Any) → ’_models.TagContract’[source]¶

Get tag associated with the Operation.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance.
tag_id (str) – Tag identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TagContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_by_product(resource_group_name: str, service_name: str, product_id: str, tag_id: str, **kwargs: Any) → ’_models.TagContract’[source]¶

Get tag associated with the Product.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
tag_id (str) – Tag identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TagContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_entity_state(resource_group_name: str, service_name: str, tag_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state version of the tag specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
tag_id (str) – Tag identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_entity_state_by_api(resource_group_name: str, service_name: str, api_id: str, tag_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state version of the tag specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
tag_id (str) – Tag identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_entity_state_by_operation(resource_group_name: str, service_name: str, api_id: str, operation_id: str, tag_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state version of the tag specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance.
tag_id (str) – Tag identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_entity_state_by_product(resource_group_name: str, service_name: str, product_id: str, tag_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state version of the tag specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
tag_id (str) – Tag identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_api(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.TagCollection’][source]¶

Lists all Tags associated with the API.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TagCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_operation(resource_group_name: str, service_name: str, api_id: str, operation_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.TagCollection’][source]¶

Lists all Tags associated with the Operation.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TagCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_product(resource_group_name: str, service_name: str, product_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.TagCollection’][source]¶

Lists all Tags associated with the Product.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TagCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, scope: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.TagCollection’][source]¶

Lists a collection of tags defined within a service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.
scope (str) – Scope like ‘apis’, ‘products’ or ‘apis/{apiId}.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TagCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, tag_id: str, if_match: str, parameters: ‘_models.TagCreateUpdateParameters’, **kwargs: Any) → ’_models.TagContract’[source]¶

Updates the details of the tag specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
tag_id (str) – Tag identifier. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (TagCreateUpdateParameters) – Update parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TagContract, or the result of cls(response)

Return type

ItemPaged[ProductCollection]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ApiProductOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ApiProductOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list_by_apis(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.ProductCollection’][source]¶

Lists all Products, which the API is part of.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ProductCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ApiPolicyOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ApiPolicyOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, api_id: str, policy_id: Union[str, ‘_models.PolicyIdName’], parameters: ‘_models.PolicyContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.PolicyContract’[source]¶

Creates or updates policy configuration for the API.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
policy_id (str or PolicyIdName) – The identifier of the Policy.
parameters (PolicyContract) – The policy contents to apply.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PolicyContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, api_id: str, policy_id: Union[str, ‘_models.PolicyIdName’], if_match: str, **kwargs: Any) → None [source]¶

Deletes the policy configuration at the Api.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
policy_id (str or PolicyIdName) – The identifier of the Policy.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, api_id: str, policy_id: Union[str, ‘_models.PolicyIdName’], format: Optional[Union[str, ‘_models.PolicyExportFormat’]] = 'xml', **kwargs: Any) → ’_models.PolicyContract’[source]¶

Get the policy configuration at the API level.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
policy_id (str or PolicyIdName) – The identifier of the Policy.
format (str or PolicyExportFormat) – Policy Export Format.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PolicyContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, policy_id: Union[str, ‘_models.PolicyIdName’], **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the API policy specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
policy_id (str or PolicyIdName) – The identifier of the Policy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_api(resource_group_name: str, service_name: str, api_id: str, **kwargs: Any) → ’_models.PolicyCollection’[source]¶

Get the policy configuration at the API level.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PolicyCollection, or the result of cls(response)

Return type

LROPoller[SchemaContract]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ApiSchemaOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ApiSchemaOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, service_name: str, api_id: str, schema_id: str, parameters: ‘_models.SchemaContract’, if_match: Optional[str] = None, **kwargs: Any) → LROPoller[‘_models.SchemaContract’][source]¶

Creates or updates schema configuration for the API.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
schema_id (str) – Schema identifier within an API. Must be unique in the current API Management service instance.
parameters (SchemaContract) – The schema contents to apply.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either SchemaContract or the result of cls(response)

Return type

Raises

delete(resource_group_name: str, service_name: str, api_id: str, schema_id: str, if_match: str, force: Optional[bool] = None, **kwargs: Any) → None [source]¶

Deletes the schema configuration at the Api.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
schema_id (str) – Schema identifier within an API. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
force (bool) – If true removes all references to the schema before deleting it.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, api_id: str, schema_id: str, **kwargs: Any) → ’_models.SchemaContract’[source]¶

Get the schema configuration at the API level.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
schema_id (str) – Schema identifier within an API. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SchemaContract, or the result of cls(response)

Return type

SchemaContract

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, schema_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the schema specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
schema_id (str) – Schema identifier within an API. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[SchemaCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_api(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.SchemaCollection’][source]¶

Get the schema configuration at the API level.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| contentType | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SchemaCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ApiDiagnosticOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ApiDiagnosticOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, api_id: str, diagnostic_id: str, parameters: ‘_models.DiagnosticContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.DiagnosticContract’[source]¶

Creates a new Diagnostic for an API or updates an existing one.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance.
parameters (DiagnosticContract) – Create parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DiagnosticContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, api_id: str, diagnostic_id: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes the specified Diagnostic from an API.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, api_id: str, diagnostic_id: str, **kwargs: Any) → ’_models.DiagnosticContract’[source]¶

Gets the details of the Diagnostic for an API specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DiagnosticContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, diagnostic_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[DiagnosticCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.DiagnosticCollection’][source]¶

Lists all diagnostics of an API.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DiagnosticCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, api_id: str, diagnostic_id: str, if_match: str, parameters: ‘_models.DiagnosticContract’, **kwargs: Any) → ’_models.DiagnosticContract’[source]¶

Updates the details of the Diagnostic for an API specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (DiagnosticContract) – Diagnostic Update parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DiagnosticContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ApiIssueOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ApiIssueOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, api_id: str, issue_id: str, parameters: ‘_models.IssueContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.IssueContract’[source]¶

Creates a new Issue for an API or updates an existing one.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
issue_id (str) – Issue identifier. Must be unique in the current API Management service instance.
parameters (IssueContract) – Create parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IssueContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, api_id: str, issue_id: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes the specified Issue from an API.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
issue_id (str) – Issue identifier. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, api_id: str, issue_id: str, expand_comments_attachments: Optional[bool] = None, **kwargs: Any) → ’_models.IssueContract’[source]¶

Gets the details of the Issue for an API specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
issue_id (str) – Issue identifier. Must be unique in the current API Management service instance.
expand_comments_attachments (bool) – Expand the comment attachments.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IssueContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, issue_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the Issue for an API specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
issue_id (str) – Issue identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[IssueCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, expand_comments_attachments: Optional[bool] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.IssueCollection’][source]¶

Lists all issues associated with the specified API.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || state | filter | eq | |.
expand_comments_attachments (bool) – Expand the comment attachments.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either IssueCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, api_id: str, issue_id: str, if_match: str, parameters: ‘_models.IssueUpdateContract’, **kwargs: Any) → ’_models.IssueContract’[source]¶

Updates an existing issue for an API.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
issue_id (str) – Issue identifier. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (IssueUpdateContract) – Update parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IssueContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ApiIssueCommentOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ApiIssueCommentOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, api_id: str, issue_id: str, comment_id: str, parameters: ‘_models.IssueCommentContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.IssueCommentContract’[source]¶

Creates a new Comment for the Issue in an API or updates an existing one.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
issue_id (str) – Issue identifier. Must be unique in the current API Management service instance.
comment_id (str) – Comment identifier within an Issue. Must be unique in the current Issue.
parameters (IssueCommentContract) – Create parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IssueCommentContract, or the result of cls(response)

Return type

IssueCommentContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, api_id: str, issue_id: str, comment_id: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes the specified comment from an Issue.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
issue_id (str) – Issue identifier. Must be unique in the current API Management service instance.
comment_id (str) – Comment identifier within an Issue. Must be unique in the current Issue.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, api_id: str, issue_id: str, comment_id: str, **kwargs: Any) → ’_models.IssueCommentContract’[source]¶

Gets the details of the issue Comment for an API specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
issue_id (str) – Issue identifier. Must be unique in the current API Management service instance.
comment_id (str) – Comment identifier within an Issue. Must be unique in the current Issue.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IssueCommentContract, or the result of cls(response)

Return type

IssueCommentContract

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, issue_id: str, comment_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the issue Comment for an API specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
issue_id (str) – Issue identifier. Must be unique in the current API Management service instance.
comment_id (str) – Comment identifier within an Issue. Must be unique in the current Issue.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[IssueCommentCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, api_id: str, issue_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.IssueCommentCollection’][source]¶

Lists all comments for the Issue associated with the specified API.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
issue_id (str) – Issue identifier. Must be unique in the current API Management service instance.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either IssueCommentCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ApiIssueAttachmentOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ApiIssueAttachmentOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, api_id: str, issue_id: str, attachment_id: str, parameters: ‘_models.IssueAttachmentContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.IssueAttachmentContract’[source]¶

Creates a new Attachment for the Issue in an API or updates an existing one.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
issue_id (str) – Issue identifier. Must be unique in the current API Management service instance.
attachment_id (str) – Attachment identifier within an Issue. Must be unique in the current Issue.
parameters (IssueAttachmentContract) – Create parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IssueAttachmentContract, or the result of cls(response)

Return type

IssueAttachmentContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, api_id: str, issue_id: str, attachment_id: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes the specified comment from an Issue.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
issue_id (str) – Issue identifier. Must be unique in the current API Management service instance.
attachment_id (str) – Attachment identifier within an Issue. Must be unique in the current Issue.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, api_id: str, issue_id: str, attachment_id: str, **kwargs: Any) → ’_models.IssueAttachmentContract’[source]¶

Gets the details of the issue Attachment for an API specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
issue_id (str) – Issue identifier. Must be unique in the current API Management service instance.
attachment_id (str) – Attachment identifier within an Issue. Must be unique in the current Issue.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IssueAttachmentContract, or the result of cls(response)

Return type

IssueAttachmentContract

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, issue_id: str, attachment_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the issue Attachment for an API specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
issue_id (str) – Issue identifier. Must be unique in the current API Management service instance.
attachment_id (str) – Attachment identifier within an Issue. Must be unique in the current Issue.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[IssueAttachmentCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, api_id: str, issue_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.IssueAttachmentCollection’][source]¶

Lists all attachments for the Issue associated with the specified API.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
issue_id (str) – Issue identifier. Must be unique in the current API Management service instance.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either IssueAttachmentCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ApiTagDescriptionOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ApiTagDescriptionOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, api_id: str, tag_description_id: str, parameters: ‘_models.TagDescriptionCreateParameters’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.TagDescriptionContract’[source]¶

Create/Update tag description in scope of the Api.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
tag_description_id (str) – Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.
parameters (TagDescriptionCreateParameters) – Create parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TagDescriptionContract, or the result of cls(response)

Return type

TagDescriptionContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, api_id: str, tag_description_id: str, if_match: str, **kwargs: Any) → None [source]¶

Delete tag description for the Api.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
tag_description_id (str) – Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, api_id: str, tag_description_id: str, **kwargs: Any) → ’_models.TagDescriptionContract’[source]¶

Get Tag description in scope of API.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
tag_description_id (str) – Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TagDescriptionContract, or the result of cls(response)

Return type

TagDescriptionContract

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, tag_description_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state version of the tag specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
tag_description_id (str) – Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[TagDescriptionCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.TagDescriptionCollection’][source]¶

Lists all Tags descriptions in scope of API. Model similar to swagger - tagDescription is defined on API level but tag may be assigned to the Operations.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TagDescriptionCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.OperationOperations(client, config, serializer, deserializer)[source]¶

Bases: object

OperationOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list_by_tags(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, include_not_tagged_operations: Optional[bool] = None, **kwargs: Any) → Iterable[‘_models.TagResourceCollection’][source]¶

Lists a collection of operations associated with tags.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || apiName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.
include_not_tagged_operations (bool) – Include not tagged Operations.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TagResourceCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ApiExportOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ApiExportOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_group_name: str, service_name: str, api_id: str, format: Union[str, ‘_models.ExportFormat’], export: Union[str, ‘_models.ExportApi’], **kwargs: Any) → ’_models.ApiExportResult’[source]¶

Gets the details of the API specified by its identifier in the format specified to the Storage Blob with SAS Key valid for 5 minutes.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.
format (str or ExportFormat) – Format in which to export the Api Details to the Storage Blob with Sas Key valid for 5 minutes.
export (str or ExportApi) – Query parameter required to export the API details.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ApiExportResult, or the result of cls(response)

Return type

ApiExportResult

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ApiVersionSetOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ApiVersionSetOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, version_set_id: str, parameters: ‘_models.ApiVersionSetContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.ApiVersionSetContract’[source]¶

Creates or Updates a Api Version Set.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
version_set_id (str) – Api Version Set identifier. Must be unique in the current API Management service instance.
parameters (ApiVersionSetContract) – Create or update parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ApiVersionSetContract, or the result of cls(response)

Return type

ApiVersionSetContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, version_set_id: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes specific Api Version Set.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
version_set_id (str) – Api Version Set identifier. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, version_set_id: str, **kwargs: Any) → ’_models.ApiVersionSetContract’[source]¶

Gets the details of the Api Version Set specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
version_set_id (str) – Api Version Set identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ApiVersionSetContract, or the result of cls(response)

Return type

ApiVersionSetContract

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, version_set_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the Api Version Set specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
version_set_id (str) – Api Version Set identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[ApiVersionSetCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.ApiVersionSetCollection’][source]¶

Lists a collection of API Version Sets in the specified service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|————-|.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ApiVersionSetCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, version_set_id: str, if_match: str, parameters: ‘_models.ApiVersionSetUpdateParameters’, **kwargs: Any) → ’_models.ApiVersionSetContract’[source]¶

Updates the details of the Api VersionSet specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
version_set_id (str) – Api Version Set identifier. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (ApiVersionSetUpdateParameters) – Update parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ApiVersionSetContract, or the result of cls(response)

Return type

ApiVersionSetContract

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.AuthorizationServerOperations(client, config, serializer, deserializer)[source]¶

Bases: object

AuthorizationServerOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, authsid: str, parameters: ‘_models.AuthorizationServerContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.AuthorizationServerContract’[source]¶

Creates new authorization server or updates an existing authorization server.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
authsid (str) – Identifier of the authorization server.
parameters (AuthorizationServerContract) – Create or update parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AuthorizationServerContract, or the result of cls(response)

Return type

AuthorizationServerContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, authsid: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes specific authorization server instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
authsid (str) – Identifier of the authorization server.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

AuthorizationServerContract

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, authsid: str, **kwargs: Any) → ’_models.AuthorizationServerContract’[source]¶

Gets the details of the authorization server specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
authsid (str) – Identifier of the authorization server.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AuthorizationServerContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, authsid: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the authorizationServer specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
authsid (str) – Identifier of the authorization server.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[AuthorizationServerCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.AuthorizationServerCollection’][source]¶

Lists a collection of authorization servers defined within a service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either AuthorizationServerCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_secrets(resource_group_name: str, service_name: str, authsid: str, **kwargs: Any) → ’_models.AuthorizationServerSecretsContract’[source]¶

Gets the client secret details of the authorization server.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
authsid (str) – Identifier of the authorization server.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AuthorizationServerSecretsContract, or the result of cls(response)

Return type

AuthorizationServerSecretsContract

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, authsid: str, if_match: str, parameters: ‘_models.AuthorizationServerUpdateContract’, **kwargs: Any) → ’_models.AuthorizationServerContract’[source]¶

Updates the details of the authorization server specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
authsid (str) – Identifier of the authorization server.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (AuthorizationServerUpdateContract) – OAuth2 Server settings Update parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AuthorizationServerContract, or the result of cls(response)

Return type

AuthorizationServerContract

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.BackendOperations(client, config, serializer, deserializer)[source]¶

Bases: object

BackendOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, backend_id: str, parameters: ‘_models.BackendContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.BackendContract’[source]¶

Creates or Updates a backend.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
backend_id (str) – Identifier of the Backend entity. Must be unique in the current API Management service instance.
parameters (BackendContract) – Create parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

BackendContract, or the result of cls(response)

Return type

BackendContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, backend_id: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes the specified backend.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
backend_id (str) – Identifier of the Backend entity. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, backend_id: str, **kwargs: Any) → ’_models.BackendContract’[source]¶

Gets the details of the backend specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
backend_id (str) – Identifier of the Backend entity. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

BackendContract, or the result of cls(response)

Return type

BackendContract

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, backend_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the backend specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
backend_id (str) – Identifier of the Backend entity. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[BackendCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.BackendCollection’][source]¶

Lists a collection of backends in the specified service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || url | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either BackendCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

reconnect(resource_group_name: str, service_name: str, backend_id: str, parameters: Optional[‘_models.BackendReconnectContract’] = None, **kwargs: Any) → None [source]¶

Notifies the APIM proxy to create a new connection to the backend after the specified timeout. If no timeout was specified, timeout of 2 minutes is used.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
backend_id (str) – Identifier of the Backend entity. Must be unique in the current API Management service instance.
parameters (BackendReconnectContract) – Reconnect request parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, backend_id: str, if_match: str, parameters: ‘_models.BackendUpdateParameters’, **kwargs: Any) → ’_models.BackendContract’[source]¶

Updates an existing backend.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
backend_id (str) – Identifier of the Backend entity. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (BackendUpdateParameters) – Update parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

BackendContract, or the result of cls(response)

Return type

BackendContract

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.CacheOperations(client, config, serializer, deserializer)[source]¶

Bases: object

CacheOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, cache_id: str, parameters: ‘_models.CacheContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.CacheContract’[source]¶

Creates or updates an External Cache to be used in Api Management instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
cache_id (str) – Identifier of the Cache entity. Cache identifier (should be either ‘default’ or valid Azure region identifier).
parameters (CacheContract) – Create or Update parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

CacheContract, or the result of cls(response)

Return type

CacheContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, cache_id: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes specific Cache.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
cache_id (str) – Identifier of the Cache entity. Cache identifier (should be either ‘default’ or valid Azure region identifier).
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, cache_id: str, **kwargs: Any) → ’_models.CacheContract’[source]¶

Gets the details of the Cache specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
cache_id (str) – Identifier of the Cache entity. Cache identifier (should be either ‘default’ or valid Azure region identifier).

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

CacheContract, or the result of cls(response)

Return type

CacheContract

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, cache_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the Cache specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
cache_id (str) – Identifier of the Cache entity. Cache identifier (should be either ‘default’ or valid Azure region identifier).

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[CacheCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.CacheCollection’][source]¶

Lists a collection of all external Caches in the specified service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either CacheCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, cache_id: str, if_match: str, parameters: ‘_models.CacheUpdateParameters’, **kwargs: Any) → ’_models.CacheContract’[source]¶

Updates the details of the cache specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
cache_id (str) – Identifier of the Cache entity. Cache identifier (should be either ‘default’ or valid Azure region identifier).
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (CacheUpdateParameters) – Update parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

CacheContract, or the result of cls(response)

Return type

CacheContract

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.CertificateOperations(client, config, serializer, deserializer)[source]¶

Bases: object

CertificateOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, certificate_id: str, parameters: ‘_models.CertificateCreateOrUpdateParameters’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.CertificateContract’[source]¶

Creates or updates the certificate being used for authentication with the backend.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
certificate_id (str) – Identifier of the certificate entity. Must be unique in the current API Management service instance.
parameters (CertificateCreateOrUpdateParameters) – Create or Update parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

CertificateContract, or the result of cls(response)

Return type

CertificateContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, certificate_id: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes specific certificate.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
certificate_id (str) – Identifier of the certificate entity. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, certificate_id: str, **kwargs: Any) → ’_models.CertificateContract’[source]¶

Gets the details of the certificate specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
certificate_id (str) – Identifier of the certificate entity. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

CertificateContract, or the result of cls(response)

Return type

CertificateContract

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, certificate_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the certificate specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
certificate_id (str) – Identifier of the certificate entity. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[CertificateCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.CertificateCollection’][source]¶

Lists a collection of all certificates in the specified service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || expirationDate | filter | ge, le, eq, ne, gt, lt | |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either CertificateCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ContentTypeOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ContentTypeOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, content_type_id: str, if_match: Optional[str] = None, **kwargs: Any) → ’_models.ContentTypeContract’[source]¶

Creates or updates an Content Type.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
content_type_id (str) – Content type identifier.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ContentTypeContract, or the result of cls(response)

Return type

ContentTypeContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, content_type_id: str, if_match: str, **kwargs: Any) → None [source]¶

Removes specified content type.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
content_type_id (str) – Content type identifier.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ItemPaged[ContentTypeCollection]

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, content_type_id: str, **kwargs: Any) → ’_models.ContentTypeContract’[source]¶

Gets API Management content type details.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
content_type_id (str) – Content type identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ContentTypeContract, or the result of cls(response)

Return type

ContentTypeContract

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, **kwargs: Any) → Iterable[‘_models.ContentTypeCollection’][source]¶

Returns list of content types.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ContentTypeCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ContentItemOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ContentItemOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, content_type_id: str, content_item_id: str, if_match: Optional[str] = None, **kwargs: Any) → ’_models.ContentItemContract’[source]¶

Creates new content item.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
content_type_id (str) – Content type identifier.
content_item_id (str) – Content item identifier.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ContentItemContract, or the result of cls(response)

Return type

ContentItemContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, content_type_id: str, content_item_id: str, if_match: str, **kwargs: Any) → None [source]¶

Removes specified content item.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
content_type_id (str) – Content type identifier.
content_item_id (str) – Content item identifier.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, content_type_id: str, content_item_id: str, **kwargs: Any) → ’_models.ContentItemContract’[source]¶

Returns content item details.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
content_type_id (str) – Content type identifier.
content_item_id (str) – Content item identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ContentItemContract, or the result of cls(response)

Return type

ContentItemContract

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, content_type_id: str, content_item_id: str, **kwargs: Any) → bool [source]¶

Returns content item metadata.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
content_type_id (str) – Content type identifier.
content_item_id (str) – Content item identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[ContentItemCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, content_type_id: str, **kwargs: Any) → Iterable[‘_models.ContentItemCollection’][source]¶

Returns list of content items.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
content_type_id (str) – Content type identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ContentItemCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.DeletedServicesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DeletedServicesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get_by_name(service_name: str, location: str, **kwargs: Any) → ’_models.DeletedServiceContract’[source]¶

Get soft-deleted Api Management Service by name.

Parameters

service_name (str) – The name of the API Management service.
location (str) – The location of the deleted API Management service.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeletedServiceContract, or the result of cls(response)

Return type

DeletedServiceContract

Raises

~azure.core.exceptions.HttpResponseError

list_by_subscription(**kwargs: Any) → Iterable[‘_models.DeletedServicesCollection’][source]¶

Lists all soft-deleted services available for undelete for the given subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either DeletedServicesCollection or the result of cls(response)
Return type: ItemPaged[DeletedServicesCollection]
Raises: ~azure.core.exceptions.HttpResponseError

purge(service_name: str, location: str, **kwargs: Any) → Optional[‘_models.DeletedServiceContract’][source]¶

Purges Api Management Service (deletes it with no option to undelete).

Parameters

service_name (str) – The name of the API Management service.
location (str) – The location of the deleted API Management service.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DeletedServiceContract, or the result of cls(response)

Return type

DeletedServiceContract or None

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ApiManagementOperationsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ApiManagementOperationsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(**kwargs: Any) → Iterable[‘_models.OperationListResult’][source]¶

Lists all of the available REST API operations of the Microsoft.ApiManagement provider.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either OperationListResult or the result of cls(response)
Return type: ItemPaged[OperationListResult]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ApiManagementServiceSkusOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ApiManagementServiceSkusOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list_available_service_skus(resource_group_name: str, service_name: str, **kwargs: Any) → Iterable[‘_models.ResourceSkuResults’][source]¶

Gets available SKUs for API Management service.

Gets all available SKU for a given API Management service.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ResourceSkuResults or the result of cls(response)

Return type

ItemPaged[ResourceSkuResults]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ApiManagementServiceOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ApiManagementServiceOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_apply_network_configuration_updates(resource_group_name: str, service_name: str, parameters: Optional[‘_models.ApiManagementServiceApplyNetworkConfigurationParameters’] = None, **kwargs: Any) → LROPoller[‘_models.ApiManagementServiceResource’][source]¶

Updates the Microsoft.ApiManagement resource running in the Virtual network to pick the updated network settings.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
parameters (ApiManagementServiceApplyNetworkConfigurationParameters) – Parameters supplied to the Apply Network Configuration operation. If the parameters are empty, all the regions in which the Api Management service is deployed will be updated sequentially without incurring downtime in the region.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ApiManagementServiceResource or the result of cls(response)

Return type

Raises

begin_backup(resource_group_name: str, service_name: str, parameters: ‘_models.ApiManagementServiceBackupRestoreParameters’, **kwargs: Any) → LROPoller[‘_models.ApiManagementServiceResource’][source]¶

Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
parameters (ApiManagementServiceBackupRestoreParameters) – Parameters supplied to the ApiManagementService_Backup operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ApiManagementServiceResource or the result of cls(response)

Return type

Raises

begin_create_or_update(resource_group_name: str, service_name: str, parameters: ‘_models.ApiManagementServiceResource’, **kwargs: Any) → LROPoller[‘_models.ApiManagementServiceResource’][source]¶

Creates or updates an API Management service. This is long running operation and could take several minutes to complete.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
parameters (ApiManagementServiceResource) – Parameters supplied to the CreateOrUpdate API Management service operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ApiManagementServiceResource or the result of cls(response)

Return type

Raises

begin_delete(resource_group_name: str, service_name: str, **kwargs: Any) → LROPoller[‘_models.ApiManagementServiceResource’][source]¶

Deletes an existing API Management service.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

begin_restore(resource_group_name: str, service_name: str, parameters: ‘_models.ApiManagementServiceBackupRestoreParameters’, **kwargs: Any) → LROPoller[‘_models.ApiManagementServiceResource’][source]¶

Restores a backup of an API Management service created using the ApiManagementService_Backup operation on the current service. This is a long running operation and could take several minutes to complete.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
parameters (ApiManagementServiceBackupRestoreParameters) – Parameters supplied to the Restore API Management service from backup operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ApiManagementServiceResource or the result of cls(response)

Return type

Raises

begin_update(resource_group_name: str, service_name: str, parameters: ‘_models.ApiManagementServiceUpdateParameters’, **kwargs: Any) → LROPoller[‘_models.ApiManagementServiceResource’][source]¶

Updates an existing API Management service.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
parameters (ApiManagementServiceUpdateParameters) – Parameters supplied to the CreateOrUpdate API Management service operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either ApiManagementServiceResource or the result of cls(response)

Return type

Raises

ApiManagementServiceResource

check_name_availability(parameters: ‘_models.ApiManagementServiceCheckNameAvailabilityParameters’, **kwargs: Any) → ’_models.ApiManagementServiceNameAvailabilityResult’[source]¶

Checks availability and correctness of a name for an API Management service.

Parameters: parameters (ApiManagementServiceCheckNameAvailabilityParameters) – Parameters supplied to the CheckNameAvailability operation.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: ApiManagementServiceNameAvailabilityResult, or the result of cls(response)
Return type: ApiManagementServiceNameAvailabilityResult
Raises: ~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, **kwargs: Any) → ’_models.ApiManagementServiceResource’[source]¶

Gets an API Management service resource description.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ApiManagementServiceResource, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_sso_token(resource_group_name: str, service_name: str, **kwargs: Any) → ’_models.ApiManagementServiceGetSsoTokenResult’[source]¶

Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ApiManagementServiceGetSsoTokenResult, or the result of cls(response)

Return type

ApiManagementServiceGetSsoTokenResult

Raises

~azure.core.exceptions.HttpResponseError

list(**kwargs: Any) → Iterable[‘_models.ApiManagementServiceListResult’][source]¶

Lists all API Management services within an Azure subscription.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ApiManagementServiceListResult or the result of cls(response)
Return type: ItemPaged[ApiManagementServiceListResult]
Raises: ~azure.core.exceptions.HttpResponseError

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[‘_models.ApiManagementServiceListResult’][source]¶

List all API Management services within a resource group.

Parameters: resource_group_name (str) – The name of the resource group.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ApiManagementServiceListResult or the result of cls(response)
Return type: ItemPaged[ApiManagementServiceListResult]
Raises: ~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.DiagnosticOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DiagnosticOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, diagnostic_id: str, parameters: ‘_models.DiagnosticContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.DiagnosticContract’[source]¶

Creates a new Diagnostic or updates an existing one.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance.
parameters (DiagnosticContract) – Create parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DiagnosticContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, diagnostic_id: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes the specified Diagnostic.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, diagnostic_id: str, **kwargs: Any) → ’_models.DiagnosticContract’[source]¶

Gets the details of the Diagnostic specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DiagnosticContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, diagnostic_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the Diagnostic specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[DiagnosticCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.DiagnosticCollection’][source]¶

Lists all diagnostics of the API Management service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either DiagnosticCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, diagnostic_id: str, if_match: str, parameters: ‘_models.DiagnosticContract’, **kwargs: Any) → ’_models.DiagnosticContract’[source]¶

Updates the details of the Diagnostic specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (DiagnosticContract) – Diagnostic Update parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

DiagnosticContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.EmailTemplateOperations(client, config, serializer, deserializer)[source]¶

Bases: object

EmailTemplateOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, template_name: Union[str, ‘_models.TemplateName’], parameters: ‘_models.EmailTemplateUpdateParameters’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.EmailTemplateContract’[source]¶

Updates an Email Template.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
template_name (str or TemplateName) – Email Template Name Identifier.
parameters (EmailTemplateUpdateParameters) – Email Template update parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EmailTemplateContract, or the result of cls(response)

Return type

EmailTemplateContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, template_name: Union[str, ‘_models.TemplateName’], if_match: str, **kwargs: Any) → None [source]¶

Reset the Email Template to default template provided by the API Management service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
template_name (str or TemplateName) – Email Template Name Identifier.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, template_name: Union[str, ‘_models.TemplateName’], **kwargs: Any) → ’_models.EmailTemplateContract’[source]¶

Gets the details of the email template specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
template_name (str or TemplateName) – Email Template Name Identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EmailTemplateContract, or the result of cls(response)

Return type

EmailTemplateContract

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, template_name: Union[str, ‘_models.TemplateName’], **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the email template specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
template_name (str or TemplateName) – Email Template Name Identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[EmailTemplateCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.EmailTemplateCollection’][source]¶

Gets all email templates.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either EmailTemplateCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, template_name: Union[str, ‘_models.TemplateName’], if_match: str, parameters: ‘_models.EmailTemplateUpdateParameters’, **kwargs: Any) → ’_models.EmailTemplateContract’[source]¶

Updates API Management email template.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
template_name (str or TemplateName) – Email Template Name Identifier.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (EmailTemplateUpdateParameters) – Update parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

EmailTemplateContract, or the result of cls(response)

Return type

EmailTemplateContract

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.GatewayOperations(client, config, serializer, deserializer)[source]¶

Bases: object

GatewayOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, gateway_id: str, parameters: ‘_models.GatewayContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.GatewayContract’[source]¶

Creates or updates a Gateway to be used in Api Management instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’.
parameters (GatewayContract) –
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GatewayContract, or the result of cls(response)

Return type

GatewayContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, gateway_id: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes specific Gateway.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

generate_token(resource_group_name: str, service_name: str, gateway_id: str, parameters: ‘_models.GatewayTokenRequestContract’, **kwargs: Any) → ’_models.GatewayTokenContract’[source]¶

Gets the Shared Access Authorization Token for the gateway.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’.
parameters (GatewayTokenRequestContract) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GatewayTokenContract, or the result of cls(response)

Return type

GatewayTokenContract

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, gateway_id: str, **kwargs: Any) → ’_models.GatewayContract’[source]¶

Gets the details of the Gateway specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GatewayContract, or the result of cls(response)

Return type

GatewayContract

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, gateway_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the Gateway specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[GatewayCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.GatewayCollection’][source]¶

Lists a collection of gateways registered with service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || region | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either GatewayCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_keys(resource_group_name: str, service_name: str, gateway_id: str, **kwargs: Any) → ’_models.GatewayKeysContract’[source]¶

Retrieves gateway keys.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GatewayKeysContract, or the result of cls(response)

Return type

GatewayKeysContract

Raises

~azure.core.exceptions.HttpResponseError

regenerate_key(resource_group_name: str, service_name: str, gateway_id: str, parameters: ‘_models.GatewayKeyRegenerationRequestContract’, **kwargs: Any) → None [source]¶

Regenerates specified gateway key invalidating any tokens created with it.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’.
parameters (GatewayKeyRegenerationRequestContract) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

GatewayHostnameConfigurationContract

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, gateway_id: str, if_match: str, parameters: ‘_models.GatewayContract’, **kwargs: Any) → ’_models.GatewayContract’[source]¶

Updates the details of the gateway specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (GatewayContract) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GatewayContract, or the result of cls(response)

Return type

GatewayContract

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.GatewayHostnameConfigurationOperations(client, config, serializer, deserializer)[source]¶

Bases: object

GatewayHostnameConfigurationOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, gateway_id: str, hc_id: str, parameters: ‘_models.GatewayHostnameConfigurationContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.GatewayHostnameConfigurationContract’[source]¶

Creates of updates hostname configuration for a Gateway.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’.
hc_id (str) – Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
parameters (GatewayHostnameConfigurationContract) –
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GatewayHostnameConfigurationContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, gateway_id: str, hc_id: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes the specified hostname configuration from the specified Gateway.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’.
hc_id (str) – Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

GatewayHostnameConfigurationContract

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, gateway_id: str, hc_id: str, **kwargs: Any) → ’_models.GatewayHostnameConfigurationContract’[source]¶

Get details of a hostname configuration.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’.
hc_id (str) – Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GatewayHostnameConfigurationContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, gateway_id: str, hc_id: str, **kwargs: Any) → bool [source]¶

Checks that hostname configuration entity specified by identifier exists for specified Gateway entity.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’.
hc_id (str) – Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[GatewayHostnameConfigurationCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, gateway_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.GatewayHostnameConfigurationCollection’][source]¶

Lists the collection of hostname configurations for the specified gateway.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || hostname | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either GatewayHostnameConfigurationCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.GatewayApiOperations(client, config, serializer, deserializer)[source]¶

Bases: object

GatewayApiOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, gateway_id: str, api_id: str, parameters: Optional[‘_models.AssociationContract’] = None, **kwargs: Any) → ’_models.ApiContract’[source]¶

Adds an API to the specified Gateway.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’.
api_id (str) – API identifier. Must be unique in the current API Management service instance.
parameters (AssociationContract) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ApiContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, gateway_id: str, api_id: str, **kwargs: Any) → None [source]¶

Deletes the specified API from the specified Gateway.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’.
api_id (str) – API identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, gateway_id: str, api_id: str, **kwargs: Any) → bool [source]¶

Checks that API entity specified by identifier is associated with the Gateway entity.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’.
api_id (str) – API identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, gateway_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.ApiCollection’][source]¶

Lists a collection of the APIs associated with a gateway.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ApiCollection or the result of cls(response)

Return type

ItemPaged[ApiCollection]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.GroupOperations(client, config, serializer, deserializer)[source]¶

Bases: object

GroupOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, group_id: str, parameters: ‘_models.GroupCreateParameters’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.GroupContract’[source]¶

Creates or Updates a group.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
group_id (str) – Group identifier. Must be unique in the current API Management service instance.
parameters (GroupCreateParameters) – Create parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GroupContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, group_id: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes specific group of the API Management service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
group_id (str) – Group identifier. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, group_id: str, **kwargs: Any) → ’_models.GroupContract’[source]¶

Gets the details of the group specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
group_id (str) – Group identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GroupContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, group_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the group specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
group_id (str) – Group identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[GroupCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.GroupCollection’][source]¶

Lists a collection of groups defined within a service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || externalId | filter | eq | |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either GroupCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, group_id: str, if_match: str, parameters: ‘_models.GroupUpdateParameters’, **kwargs: Any) → ’_models.GroupContract’[source]¶

Updates the details of the group specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
group_id (str) – Group identifier. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (GroupUpdateParameters) – Update parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GroupContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.GroupUserOperations(client, config, serializer, deserializer)[source]¶

Bases: object

GroupUserOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

check_entity_exists(resource_group_name: str, service_name: str, group_id: str, user_id: str, **kwargs: Any) → bool [source]¶

Checks that user entity specified by identifier is associated with the group entity.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
group_id (str) – Group identifier. Must be unique in the current API Management service instance.
user_id (str) – User identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

create(resource_group_name: str, service_name: str, group_id: str, user_id: str, **kwargs: Any) → ’_models.UserContract’[source]¶

Add existing user to existing group.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
group_id (str) – Group identifier. Must be unique in the current API Management service instance.
user_id (str) – User identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

UserContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, group_id: str, user_id: str, **kwargs: Any) → None [source]¶

Remove existing user from existing group.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
group_id (str) – Group identifier. Must be unique in the current API Management service instance.
user_id (str) – User identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ItemPaged[UserCollection]

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, service_name: str, group_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.UserCollection’][source]¶

Lists a collection of user entities associated with the group.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
group_id (str) – Group identifier. Must be unique in the current API Management service instance.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || registrationDate | filter | ge, le, eq, ne, gt, lt | || note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either UserCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.IdentityProviderOperations(client, config, serializer, deserializer)[source]¶

Bases: object

IdentityProviderOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, identity_provider_name: Union[str, ‘_models.IdentityProviderType’], parameters: ‘_models.IdentityProviderCreateContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.IdentityProviderContract’[source]¶

Creates or Updates the IdentityProvider configuration.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
identity_provider_name (str or IdentityProviderType) – Identity Provider Type identifier.
parameters (IdentityProviderCreateContract) – Create parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IdentityProviderContract, or the result of cls(response)

Return type

IdentityProviderContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, identity_provider_name: Union[str, ‘_models.IdentityProviderType’], if_match: str, **kwargs: Any) → None [source]¶

Deletes the specified identity provider configuration.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
identity_provider_name (str or IdentityProviderType) – Identity Provider Type identifier.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, identity_provider_name: Union[str, ‘_models.IdentityProviderType’], **kwargs: Any) → ’_models.IdentityProviderContract’[source]¶

Gets the configuration details of the identity Provider configured in specified service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
identity_provider_name (str or IdentityProviderType) – Identity Provider Type identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IdentityProviderContract, or the result of cls(response)

Return type

IdentityProviderContract

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, identity_provider_name: Union[str, ‘_models.IdentityProviderType’], **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the identityProvider specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
identity_provider_name (str or IdentityProviderType) – Identity Provider Type identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[IdentityProviderList]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, **kwargs: Any) → Iterable[‘_models.IdentityProviderList’][source]¶

Lists a collection of Identity Provider configured in the specified service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either IdentityProviderList or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_secrets(resource_group_name: str, service_name: str, identity_provider_name: Union[str, ‘_models.IdentityProviderType’], **kwargs: Any) → ’_models.ClientSecretContract’[source]¶

Gets the client secret details of the Identity Provider.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
identity_provider_name (str or IdentityProviderType) – Identity Provider Type identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ClientSecretContract, or the result of cls(response)

Return type

ClientSecretContract

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, identity_provider_name: Union[str, ‘_models.IdentityProviderType’], if_match: str, parameters: ‘_models.IdentityProviderUpdateParameters’, **kwargs: Any) → ’_models.IdentityProviderContract’[source]¶

Updates an existing IdentityProvider configuration.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
identity_provider_name (str or IdentityProviderType) – Identity Provider Type identifier.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (IdentityProviderUpdateParameters) – Update parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IdentityProviderContract, or the result of cls(response)

Return type

IdentityProviderContract

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.IssueOperations(client, config, serializer, deserializer)[source]¶

Bases: object

IssueOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_group_name: str, service_name: str, issue_id: str, **kwargs: Any) → ’_models.IssueContract’[source]¶

Gets API Management issue details.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
issue_id (str) – Issue identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

IssueContract, or the result of cls(response)

Return type

ItemPaged[IssueCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.IssueCollection’][source]¶

Lists a collection of issues in the specified service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || authorName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || state | filter | eq | |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either IssueCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.LoggerOperations(client, config, serializer, deserializer)[source]¶

Bases: object

LoggerOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, logger_id: str, parameters: ‘_models.LoggerContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.LoggerContract’[source]¶

Creates or Updates a logger.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
logger_id (str) – Logger identifier. Must be unique in the API Management service instance.
parameters (LoggerContract) – Create parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LoggerContract, or the result of cls(response)

Return type

LoggerContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, logger_id: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes the specified logger.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
logger_id (str) – Logger identifier. Must be unique in the API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, logger_id: str, **kwargs: Any) → ’_models.LoggerContract’[source]¶

Gets the details of the logger specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
logger_id (str) – Logger identifier. Must be unique in the API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LoggerContract, or the result of cls(response)

Return type

LoggerContract

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, logger_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the logger specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
logger_id (str) – Logger identifier. Must be unique in the API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[LoggerCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.LoggerCollection’][source]¶

Lists a collection of loggers in the specified service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || loggerType | filter | eq | || resourceId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either LoggerCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, logger_id: str, if_match: str, parameters: ‘_models.LoggerUpdateContract’, **kwargs: Any) → ’_models.LoggerContract’[source]¶

Updates an existing logger.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
logger_id (str) – Logger identifier. Must be unique in the API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (LoggerUpdateContract) – Update parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

LoggerContract, or the result of cls(response)

Return type

LoggerContract

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.NamedValueOperations(client, config, serializer, deserializer)[source]¶

Bases: object

NamedValueOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, service_name: str, named_value_id: str, parameters: ‘_models.NamedValueCreateContract’, if_match: Optional[str] = None, **kwargs: Any) → LROPoller[‘_models.NamedValueContract’][source]¶

Creates or updates named value.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
named_value_id (str) – Identifier of the NamedValue.
parameters (NamedValueCreateContract) – Create parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either NamedValueContract or the result of cls(response)

Return type

LROPoller[NamedValueContract]

Raises

LROPoller[NamedValueContract]

begin_update(resource_group_name: str, service_name: str, named_value_id: str, if_match: str, parameters: ‘_models.NamedValueUpdateParameters’, **kwargs: Any) → LROPoller[‘_models.NamedValueContract’][source]¶

Updates the specific named value.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
named_value_id (str) – Identifier of the NamedValue.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (NamedValueUpdateParameters) – Update parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either NamedValueContract or the result of cls(response)

Return type

Raises

delete(resource_group_name: str, service_name: str, named_value_id: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes specific named value from the API Management service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
named_value_id (str) – Identifier of the NamedValue.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, named_value_id: str, **kwargs: Any) → ’_models.NamedValueContract’[source]¶

Gets the details of the named value specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
named_value_id (str) – Identifier of the NamedValue.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

NamedValueContract, or the result of cls(response)

Return type

NamedValueContract

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, named_value_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the named value specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
named_value_id (str) – Identifier of the NamedValue.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[NamedValueCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.NamedValueCollection’][source]¶

Lists a collection of named values defined within a service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| tags | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either NamedValueCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_value(resource_group_name: str, service_name: str, named_value_id: str, **kwargs: Any) → ’_models.NamedValueSecretContract’[source]¶

Gets the secret of the named value specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
named_value_id (str) – Identifier of the NamedValue.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

NamedValueSecretContract, or the result of cls(response)

Return type

NamedValueSecretContract

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.NetworkStatusOperations(client, config, serializer, deserializer)[source]¶

Bases: object

NetworkStatusOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list_by_location(resource_group_name: str, service_name: str, location_name: str, **kwargs: Any) → ’_models.NetworkStatusContract’[source]¶

Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
location_name (str) – Location in which the API Management service is deployed. This is one of the Azure Regions like West US, East US, South Central US.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

NetworkStatusContract, or the result of cls(response)

Return type

NetworkStatusContract

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, **kwargs: Any) → List[‘_models.NetworkStatusContractByLocation’][source]¶

Gets the Connectivity Status to the external resources on which the Api Management service depends from inside the Cloud Service. This also returns the DNS Servers as visible to the CloudService.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

list of NetworkStatusContractByLocation, or the result of cls(response)

Return type

list[NetworkStatusContractByLocation]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.NotificationOperations(client, config, serializer, deserializer)[source]¶

Bases: object

NotificationOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, notification_name: Union[str, ‘_models.NotificationName’], if_match: Optional[str] = None, **kwargs: Any) → ’_models.NotificationContract’[source]¶

Create or Update API Management publisher notification.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
notification_name (str or NotificationName) – Notification Name Identifier.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

NotificationContract, or the result of cls(response)

Return type

NotificationContract

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, notification_name: Union[str, ‘_models.NotificationName’], **kwargs: Any) → ’_models.NotificationContract’[source]¶

Gets the details of the Notification specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
notification_name (str or NotificationName) – Notification Name Identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

NotificationContract, or the result of cls(response)

Return type

NotificationContract

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.NotificationCollection’][source]¶

Lists a collection of properties defined within a service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either NotificationCollection or the result of cls(response)

Return type

ItemPaged[NotificationCollection]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.NotificationRecipientUserOperations(client, config, serializer, deserializer)[source]¶

Bases: object

NotificationRecipientUserOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

check_entity_exists(resource_group_name: str, service_name: str, notification_name: Union[str, ‘_models.NotificationName’], user_id: str, **kwargs: Any) → bool [source]¶

Determine if the Notification Recipient User is subscribed to the notification.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
notification_name (str or NotificationName) – Notification Name Identifier.
user_id (str) – User identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

create_or_update(resource_group_name: str, service_name: str, notification_name: Union[str, ‘_models.NotificationName’], user_id: str, **kwargs: Any) → ’_models.RecipientUserContract’[source]¶

Adds the API Management User to the list of Recipients for the Notification.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
notification_name (str or NotificationName) – Notification Name Identifier.
user_id (str) – User identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RecipientUserContract, or the result of cls(response)

Return type

RecipientUserContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, notification_name: Union[str, ‘_models.NotificationName’], user_id: str, **kwargs: Any) → None [source]¶

Removes the API Management user from the list of Notification.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
notification_name (str or NotificationName) – Notification Name Identifier.
user_id (str) – User identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_notification(resource_group_name: str, service_name: str, notification_name: Union[str, ‘_models.NotificationName’], **kwargs: Any) → ’_models.RecipientUserCollection’[source]¶

Gets the list of the Notification Recipient User subscribed to the notification.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
notification_name (str or NotificationName) – Notification Name Identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RecipientUserCollection, or the result of cls(response)

Return type

RecipientUserCollection

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.NotificationRecipientEmailOperations(client, config, serializer, deserializer)[source]¶

Bases: object

NotificationRecipientEmailOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

check_entity_exists(resource_group_name: str, service_name: str, notification_name: Union[str, ‘_models.NotificationName’], email: str, **kwargs: Any) → bool [source]¶

Determine if Notification Recipient Email subscribed to the notification.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
notification_name (str or NotificationName) – Notification Name Identifier.
email (str) – Email identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

create_or_update(resource_group_name: str, service_name: str, notification_name: Union[str, ‘_models.NotificationName’], email: str, **kwargs: Any) → ’_models.RecipientEmailContract’[source]¶

Adds the Email address to the list of Recipients for the Notification.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
notification_name (str or NotificationName) – Notification Name Identifier.
email (str) – Email identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RecipientEmailContract, or the result of cls(response)

Return type

RecipientEmailContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, notification_name: Union[str, ‘_models.NotificationName’], email: str, **kwargs: Any) → None [source]¶

Removes the email from the list of Notification.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
notification_name (str or NotificationName) – Notification Name Identifier.
email (str) – Email identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

OpenidConnectProviderContract

Raises

~azure.core.exceptions.HttpResponseError

list_by_notification(resource_group_name: str, service_name: str, notification_name: Union[str, ‘_models.NotificationName’], **kwargs: Any) → ’_models.RecipientEmailCollection’[source]¶

Gets the list of the Notification Recipient Emails subscribed to a notification.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
notification_name (str or NotificationName) – Notification Name Identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RecipientEmailCollection, or the result of cls(response)

Return type

RecipientEmailCollection

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.OpenIdConnectProviderOperations(client, config, serializer, deserializer)[source]¶

Bases: object

OpenIdConnectProviderOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, opid: str, parameters: ‘_models.OpenidConnectProviderContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.OpenidConnectProviderContract’[source]¶

Creates or updates the OpenID Connect Provider.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
opid (str) – Identifier of the OpenID Connect Provider.
parameters (OpenidConnectProviderContract) – Create parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

OpenidConnectProviderContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, opid: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes specific OpenID Connect Provider of the API Management service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
opid (str) – Identifier of the OpenID Connect Provider.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

OpenidConnectProviderContract

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, opid: str, **kwargs: Any) → ’_models.OpenidConnectProviderContract’[source]¶

Gets specific OpenID Connect Provider without secrets.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
opid (str) – Identifier of the OpenID Connect Provider.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

OpenidConnectProviderContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, opid: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the openIdConnectProvider specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
opid (str) – Identifier of the OpenID Connect Provider.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[OpenIdConnectProviderCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.OpenIdConnectProviderCollection’][source]¶

Lists of all the OpenId Connect Providers.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either OpenIdConnectProviderCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_secrets(resource_group_name: str, service_name: str, opid: str, **kwargs: Any) → ’_models.ClientSecretContract’[source]¶

Gets the client secret details of the OpenID Connect Provider.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
opid (str) – Identifier of the OpenID Connect Provider.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ClientSecretContract, or the result of cls(response)

Return type

ClientSecretContract

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, opid: str, if_match: str, parameters: ‘_models.OpenidConnectProviderUpdateContract’, **kwargs: Any) → ’_models.OpenidConnectProviderContract’[source]¶

Updates the specific OpenID Connect Provider.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
opid (str) – Identifier of the OpenID Connect Provider.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (OpenidConnectProviderUpdateContract) – Update parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

OpenidConnectProviderContract, or the result of cls(response)

Return type

OpenidConnectProviderContract

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.PolicyOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PolicyOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, policy_id: Union[str, ‘_models.PolicyIdName’], parameters: ‘_models.PolicyContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.PolicyContract’[source]¶

Creates or updates the global policy configuration of the Api Management service.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
policy_id (str or PolicyIdName) – The identifier of the Policy.
parameters (PolicyContract) – The policy contents to apply.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PolicyContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, policy_id: Union[str, ‘_models.PolicyIdName’], if_match: str, **kwargs: Any) → None [source]¶

Deletes the global policy configuration of the Api Management Service.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
policy_id (str or PolicyIdName) – The identifier of the Policy.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, policy_id: Union[str, ‘_models.PolicyIdName’], format: Optional[Union[str, ‘_models.PolicyExportFormat’]] = 'xml', **kwargs: Any) → ’_models.PolicyContract’[source]¶

Get the Global policy definition of the Api Management service.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
policy_id (str or PolicyIdName) – The identifier of the Policy.
format (str or PolicyExportFormat) – Policy Export Format.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PolicyContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, policy_id: Union[str, ‘_models.PolicyIdName’], **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the Global policy definition in the Api Management service.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
policy_id (str or PolicyIdName) – The identifier of the Policy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, **kwargs: Any) → ’_models.PolicyCollection’[source]¶

Lists all the Global Policy definitions of the Api Management service.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PolicyCollection, or the result of cls(response)

Return type

PolicyDescriptionCollection

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.PolicyDescriptionOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PolicyDescriptionOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list_by_service(resource_group_name: str, service_name: str, scope: Optional[Union[str, ‘_models.PolicyScopeContract’]] = None, **kwargs: Any) → ’_models.PolicyDescriptionCollection’[source]¶

Lists all policy descriptions.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
scope (str or PolicyScopeContract) – Policy scope.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PolicyDescriptionCollection, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.PortalRevisionOperations(client, config, serializer, deserializer)[source]¶

Bases: object

PortalRevisionOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_create_or_update(resource_group_name: str, service_name: str, portal_revision_id: str, parameters: ‘_models.PortalRevisionContract’, **kwargs: Any) → LROPoller[‘_models.PortalRevisionContract’][source]¶

Creates a new developer portal revision.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
portal_revision_id (str) – Portal revision identifier. Must be unique in the current API Management service instance.
parameters (PortalRevisionContract) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either PortalRevisionContract or the result of cls(response)

Return type

LROPoller[PortalRevisionContract]

Raises

LROPoller[PortalRevisionContract]

begin_update(resource_group_name: str, service_name: str, portal_revision_id: str, if_match: str, parameters: ‘_models.PortalRevisionContract’, **kwargs: Any) → LROPoller[‘_models.PortalRevisionContract’][source]¶

Updates the description of specified portal revision or makes it current.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
portal_revision_id (str) – Portal revision identifier. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (PortalRevisionContract) –

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either PortalRevisionContract or the result of cls(response)

Return type

Raises

get(resource_group_name: str, service_name: str, portal_revision_id: str, **kwargs: Any) → ’_models.PortalRevisionContract’[source]¶

Gets developer portal revision specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
portal_revision_id (str) – Portal revision identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PortalRevisionContract, or the result of cls(response)

Return type

PortalRevisionContract

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, portal_revision_id: str, **kwargs: Any) → bool [source]¶

Gets developer portal revision specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
portal_revision_id (str) – Portal revision identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[PortalRevisionCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.PortalRevisionCollection’][source]¶

Lists a collection of developer portal revision entities.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –
|name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |isCurrent | eq, ne | |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PortalRevisionCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.SignInSettingsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SignInSettingsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, parameters: ‘_models.PortalSigninSettings’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.PortalSigninSettings’[source]¶

Create or Update Sign-In settings.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
parameters (PortalSigninSettings) – Create or update parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PortalSigninSettings, or the result of cls(response)

Return type

PortalSigninSettings

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, **kwargs: Any) → ’_models.PortalSigninSettings’[source]¶

Get Sign In Settings for the Portal.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PortalSigninSettings, or the result of cls(response)

Return type

PortalSigninSettings

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the SignInSettings.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, if_match: str, parameters: ‘_models.PortalSigninSettings’, **kwargs: Any) → None [source]¶

Update Sign-In settings.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (PortalSigninSettings) – Update Sign-In settings.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.SignUpSettingsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SignUpSettingsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, parameters: ‘_models.PortalSignupSettings’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.PortalSignupSettings’[source]¶

Create or Update Sign-Up settings.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
parameters (PortalSignupSettings) – Create or update parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PortalSignupSettings, or the result of cls(response)

Return type

PortalSignupSettings

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, **kwargs: Any) → ’_models.PortalSignupSettings’[source]¶

Get Sign Up Settings for the Portal.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PortalSignupSettings, or the result of cls(response)

Return type

PortalSignupSettings

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the SignUpSettings.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, if_match: str, parameters: ‘_models.PortalSignupSettings’, **kwargs: Any) → None [source]¶

Update Sign-Up settings.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (PortalSignupSettings) – Update Sign-Up settings.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.DelegationSettingsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

DelegationSettingsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, parameters: ‘_models.PortalDelegationSettings’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.PortalDelegationSettings’[source]¶

Create or Update Delegation settings.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
parameters (PortalDelegationSettings) – Create or update parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PortalDelegationSettings, or the result of cls(response)

Return type

PortalDelegationSettings

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, **kwargs: Any) → ’_models.PortalDelegationSettings’[source]¶

Get Delegation Settings for the Portal.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PortalDelegationSettings, or the result of cls(response)

Return type

PortalDelegationSettings

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the DelegationSettings.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

PortalSettingValidationKeyContract

Raises

~azure.core.exceptions.HttpResponseError

list_secrets(resource_group_name: str, service_name: str, **kwargs: Any) → ’_models.PortalSettingValidationKeyContract’[source]¶

Gets the secret validation key of the DelegationSettings.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PortalSettingValidationKeyContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, if_match: str, parameters: ‘_models.PortalDelegationSettings’, **kwargs: Any) → None [source]¶

Update Delegation settings.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (PortalDelegationSettings) – Update Delegation settings.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ProductOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ProductOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, product_id: str, parameters: ‘_models.ProductContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.ProductContract’[source]¶

Creates or Updates a product.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
parameters (ProductContract) – Create or update parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ProductContract, or the result of cls(response)

Return type

ProductContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, product_id: str, if_match: str, delete_subscriptions: Optional[bool] = None, **kwargs: Any) → None [source]¶

Delete product.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
delete_subscriptions (bool) – Delete existing subscriptions associated with the product or not.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, product_id: str, **kwargs: Any) → ’_models.ProductContract’[source]¶

Gets the details of the product specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ProductContract, or the result of cls(response)

Return type

ProductContract

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, product_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the product specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[ProductCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, expand_groups: Optional[bool] = None, tags: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.ProductCollection’][source]¶

Lists a collection of products in the specified service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || state | filter | eq | || groups | expand | | |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.
expand_groups (bool) – When set to true, the response contains an array of groups that have visibility to the product. The default is false.
tags (str) – Products which are part of a specific tag.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ProductCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_tags(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, include_not_tagged_products: Optional[bool] = None, **kwargs: Any) → Iterable[‘_models.TagResourceCollection’][source]¶

Lists a collection of products associated with tags.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || state | filter | eq | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.
include_not_tagged_products (bool) – Include not tagged Products.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TagResourceCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, product_id: str, if_match: str, parameters: ‘_models.ProductUpdateParameters’, **kwargs: Any) → ’_models.ProductContract’[source]¶

Update existing product details.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (ProductUpdateParameters) – Update parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ProductContract, or the result of cls(response)

Return type

ProductContract

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ProductApiOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ProductApiOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

check_entity_exists(resource_group_name: str, service_name: str, product_id: str, api_id: str, **kwargs: Any) → bool [source]¶

Checks that API entity specified by identifier is associated with the Product entity.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

create_or_update(resource_group_name: str, service_name: str, product_id: str, api_id: str, **kwargs: Any) → ’_models.ApiContract’[source]¶

Adds an API to the specified product.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ApiContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, product_id: str, api_id: str, **kwargs: Any) → None [source]¶

Deletes the specified API from the specified product.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
api_id (str) – API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_product(resource_group_name: str, service_name: str, product_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.ApiCollection’][source]¶

Lists a collection of the APIs associated with a product.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ApiCollection or the result of cls(response)

Return type

ItemPaged[ApiCollection]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ProductGroupOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ProductGroupOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

check_entity_exists(resource_group_name: str, service_name: str, product_id: str, group_id: str, **kwargs: Any) → bool [source]¶

Checks that Group entity specified by identifier is associated with the Product entity.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
group_id (str) – Group identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

create_or_update(resource_group_name: str, service_name: str, product_id: str, group_id: str, **kwargs: Any) → ’_models.GroupContract’[source]¶

Adds the association between the specified developer group with the specified product.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
group_id (str) – Group identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GroupContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, product_id: str, group_id: str, **kwargs: Any) → None [source]¶

Deletes the association between the specified group and product.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
group_id (str) – Group identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

ItemPaged[GroupCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_product(resource_group_name: str, service_name: str, product_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.GroupCollection’][source]¶

Lists the collection of developer groups associated with the specified product.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | || displayName | filter | eq, ne | || description | filter | eq, ne | |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either GroupCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ProductSubscriptionsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ProductSubscriptionsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(resource_group_name: str, service_name: str, product_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.SubscriptionCollection’][source]¶

Lists the collection of subscriptions to the specified product.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || state | filter | eq | || user | expand | | |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SubscriptionCollection or the result of cls(response)

Return type

ItemPaged[SubscriptionCollection]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ProductPolicyOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ProductPolicyOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, product_id: str, policy_id: Union[str, ‘_models.PolicyIdName’], parameters: ‘_models.PolicyContract’, if_match: Optional[str] = None, **kwargs: Any) → ’_models.PolicyContract’[source]¶

Creates or updates policy configuration for the Product.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
policy_id (str or PolicyIdName) – The identifier of the Policy.
parameters (PolicyContract) – The policy contents to apply.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PolicyContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, product_id: str, policy_id: Union[str, ‘_models.PolicyIdName’], if_match: str, **kwargs: Any) → None [source]¶

Deletes the policy configuration at the Product.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
policy_id (str or PolicyIdName) – The identifier of the Policy.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, product_id: str, policy_id: Union[str, ‘_models.PolicyIdName’], format: Optional[Union[str, ‘_models.PolicyExportFormat’]] = 'xml', **kwargs: Any) → ’_models.PolicyContract’[source]¶

Get the policy configuration at the Product level.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
policy_id (str or PolicyIdName) – The identifier of the Policy.
format (str or PolicyExportFormat) – Policy Export Format.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PolicyContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, product_id: str, policy_id: Union[str, ‘_models.PolicyIdName’], **kwargs: Any) → bool [source]¶

Get the ETag of the policy configuration at the Product level.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.
policy_id (str or PolicyIdName) – The identifier of the Policy.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_product(resource_group_name: str, service_name: str, product_id: str, **kwargs: Any) → ’_models.PolicyCollection’[source]¶

Get the policy configuration at the Product level.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
product_id (str) – Product identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

PolicyCollection, or the result of cls(response)

Return type

ItemPaged[RegionListResult]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.QuotaByCounterKeysOperations(client, config, serializer, deserializer)[source]¶

Bases: object

QuotaByCounterKeysOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list_by_service(resource_group_name: str, service_name: str, quota_counter_key: str, **kwargs: Any) → ’_models.QuotaCounterCollection’[source]¶

Lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance. The api does not support paging yet.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
quota_counter_key (str) – Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter- key=”boo” in the policy, then it’s accessible by “boo” counter key. But if it’s defined as counter-key=”@(“b”+”a”)” then it will be accessible by “ba” key.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

QuotaCounterCollection, or the result of cls(response)

Return type

QuotaCounterCollection

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, quota_counter_key: str, parameters: ‘_models.QuotaCounterValueUpdateContract’, **kwargs: Any) → ’_models.QuotaCounterCollection’[source]¶

Updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance. This should be used for reset of the quota counter values.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
quota_counter_key (str) – Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter- key=”boo” in the policy, then it’s accessible by “boo” counter key. But if it’s defined as counter-key=”@(“b”+”a”)” then it will be accessible by “ba” key.
parameters (QuotaCounterValueUpdateContract) – The value of the quota counter to be applied to all quota counter periods.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

QuotaCounterCollection, or the result of cls(response)

Return type

QuotaCounterCollection

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.QuotaByPeriodKeysOperations(client, config, serializer, deserializer)[source]¶

Bases: object

QuotaByPeriodKeysOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_group_name: str, service_name: str, quota_counter_key: str, quota_period_key: str, **kwargs: Any) → ’_models.QuotaCounterContract’[source]¶

Gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
quota_counter_key (str) – Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter- key=”boo” in the policy, then it’s accessible by “boo” counter key. But if it’s defined as counter-key=”@(“b”+”a”)” then it will be accessible by “ba” key.
quota_period_key (str) – Quota period key identifier.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

QuotaCounterContract, or the result of cls(response)

Return type

QuotaCounterContract

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, quota_counter_key: str, quota_period_key: str, parameters: ‘_models.QuotaCounterValueUpdateContract’, **kwargs: Any) → ’_models.QuotaCounterContract’[source]¶

Updates an existing quota counter value in the specified service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
quota_counter_key (str) – Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter- key=”boo” in the policy, then it’s accessible by “boo” counter key. But if it’s defined as counter-key=”@(“b”+”a”)” then it will be accessible by “ba” key.
quota_period_key (str) – Quota period key identifier.
parameters (QuotaCounterValueUpdateContract) – The value of the Quota counter to be applied on the specified period.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

QuotaCounterContract, or the result of cls(response)

Return type

QuotaCounterContract

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.RegionOperations(client, config, serializer, deserializer)[source]¶

Bases: object

RegionOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list_by_service(resource_group_name: str, service_name: str, **kwargs: Any) → Iterable[‘_models.RegionListResult’][source]¶

Lists all azure regions in which the service exists.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RegionListResult or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.ReportsOperations(client, config, serializer, deserializer)[source]¶

Bases: object

ReportsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list_by_api(resource_group_name: str, service_name: str, filter: str, top: Optional[int] = None, skip: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.ReportCollection’][source]¶

Lists report records by API.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) – The filter to apply on the operation.
top (int) – Number of records to return.
skip (int) – Number of records to skip.
orderby (str) – OData order by query option.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ReportCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_geo(resource_group_name: str, service_name: str, filter: str, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.ReportCollection’][source]¶

Lists report records by geography.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| timestamp | filter | ge, le | | | country | select | | | | region | select | | | | zip | select | | | | apiRegion | filter | eq | | | userId | filter | eq | | | productId | filter | eq | | | subscriptionId | filter | eq | | | apiId | filter | eq | | | operationId | filter | eq | | | callCountSuccess | select | | | | callCountBlocked | select | | | | callCountFailed | select | | | | callCountOther | select | | | | bandwidth | select, orderBy | | | | cacheHitsCount | select | | | | cacheMissCount | select | | | | apiTimeAvg | select | | | | apiTimeMin | select | | | | apiTimeMax | select | | | | serviceTimeAvg | select | | | | serviceTimeMin | select | | | | serviceTimeMax | select | | | .
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ReportCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_operation(resource_group_name: str, service_name: str, filter: str, top: Optional[int] = None, skip: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.ReportCollection’][source]¶

Lists report records by API Operations.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| timestamp | filter | ge, le | | | displayName | select, orderBy | | | | apiRegion | filter | eq | | | userId | filter | eq | | | productId | filter | eq | | | subscriptionId | filter | eq | | | apiId | filter | eq | | | operationId | select, filter | eq | | | callCountSuccess | select, orderBy | | | | callCountBlocked | select, orderBy | | | | callCountFailed | select, orderBy | | | | callCountOther | select, orderBy | | | | callCountTotal | select, orderBy | | | | bandwidth | select, orderBy | | | | cacheHitsCount | select | | | | cacheMissCount | select | | | | apiTimeAvg | select, orderBy | | | | apiTimeMin | select | | | | apiTimeMax | select | | | | serviceTimeAvg | select | | | | serviceTimeMin | select | | | | serviceTimeMax | select | | | .
top (int) – Number of records to return.
skip (int) – Number of records to skip.
orderby (str) – OData order by query option.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ReportCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_product(resource_group_name: str, service_name: str, filter: str, top: Optional[int] = None, skip: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.ReportCollection’][source]¶

Lists report records by Product.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| timestamp | filter | ge, le | | | displayName | select, orderBy | | | | apiRegion | filter | eq | | | userId | filter | eq | | | productId | select, filter | eq | | | subscriptionId | filter | eq | | | callCountSuccess | select, orderBy | | | | callCountBlocked | select, orderBy | | | | callCountFailed | select, orderBy | | | | callCountOther | select, orderBy | | | | callCountTotal | select, orderBy | | | | bandwidth | select, orderBy | | | | cacheHitsCount | select | | | | cacheMissCount | select | | | | apiTimeAvg | select, orderBy | | | | apiTimeMin | select | | | | apiTimeMax | select | | | | serviceTimeAvg | select | | | | serviceTimeMin | select | | | | serviceTimeMax | select | | | .
top (int) – Number of records to return.
skip (int) – Number of records to skip.
orderby (str) – OData order by query option.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ReportCollection or the result of cls(response)

Return type

ItemPaged[RequestReportCollection]

Raises

~azure.core.exceptions.HttpResponseError

list_by_request(resource_group_name: str, service_name: str, filter: str, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.RequestReportCollection’][source]¶

Lists report records by Request.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| timestamp | filter | ge, le | | | apiId | filter | eq | | | operationId | filter | eq | | | productId | filter | eq | | | userId | filter | eq | | | apiRegion | filter | eq | | | subscriptionId | filter | eq | | .
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either RequestReportCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_subscription(resource_group_name: str, service_name: str, filter: str, top: Optional[int] = None, skip: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.ReportCollection’][source]¶

Lists report records by subscription.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| timestamp | filter | ge, le | | | displayName | select, orderBy | | | | apiRegion | filter | eq | | | userId | select, filter | eq | | | productId | select, filter | eq | | | subscriptionId | select, filter | eq | | | callCountSuccess | select, orderBy | | | | callCountBlocked | select, orderBy | | | | callCountFailed | select, orderBy | | | | callCountOther | select, orderBy | | | | callCountTotal | select, orderBy | | | | bandwidth | select, orderBy | | | | cacheHitsCount | select | | | | cacheMissCount | select | | | | apiTimeAvg | select, orderBy | | | | apiTimeMin | select | | | | apiTimeMax | select | | | | serviceTimeAvg | select | | | | serviceTimeMin | select | | | | serviceTimeMax | select | | | .
top (int) – Number of records to return.
skip (int) – Number of records to skip.
orderby (str) – OData order by query option.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ReportCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_time(resource_group_name: str, service_name: str, filter: str, interval: datetime.timedelta, top: Optional[int] = None, skip: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.ReportCollection’][source]¶

Lists report records by Time.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| timestamp | filter, select | ge, le | | | interval | select | | | | apiRegion | filter | eq | | | userId | filter | eq | | | productId | filter | eq | | | subscriptionId | filter | eq | | | apiId | filter | eq | | | operationId | filter | eq | | | callCountSuccess | select | | | | callCountBlocked | select | | | | callCountFailed | select | | | | callCountOther | select | | | | bandwidth | select, orderBy | | | | cacheHitsCount | select | | | | cacheMissCount | select | | | | apiTimeAvg | select | | | | apiTimeMin | select | | | | apiTimeMax | select | | | | serviceTimeAvg | select | | | | serviceTimeMin | select | | | | serviceTimeMax | select | | | .
interval (timedelta) – By time interval. 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).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)).
top (int) – Number of records to return.
skip (int) – Number of records to skip.
orderby (str) – OData order by query option.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ReportCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_by_user(resource_group_name: str, service_name: str, filter: str, top: Optional[int] = None, skip: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[‘_models.ReportCollection’][source]¶

Lists report records by User.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| timestamp | filter | ge, le | | | displayName | select, orderBy | | | | userId | select, filter | eq | | | apiRegion | filter | eq | | | productId | filter | eq | | | subscriptionId | filter | eq | | | apiId | filter | eq | | | operationId | filter | eq | | | callCountSuccess | select, orderBy | | | | callCountBlocked | select, orderBy | | | | callCountFailed | select, orderBy | | | | callCountOther | select, orderBy | | | | callCountTotal | select, orderBy | | | | bandwidth | select, orderBy | | | | cacheHitsCount | select | | | | cacheMissCount | select | | | | apiTimeAvg | select, orderBy | | | | apiTimeMin | select | | | | apiTimeMax | select | | | | serviceTimeAvg | select | | | | serviceTimeMin | select | | | | serviceTimeMax | select | | | .
top (int) – Number of records to return.
skip (int) – Number of records to skip.
orderby (str) – OData order by query option.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either ReportCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.SubscriptionOperations(client, config, serializer, deserializer)[source]¶

Bases: object

SubscriptionOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, sid: str, parameters: ‘_models.SubscriptionCreateParameters’, notify: Optional[bool] = None, if_match: Optional[str] = None, app_type: Optional[Union[str, ‘_models.AppType’]] = None, **kwargs: Any) → ’_models.SubscriptionContract’[source]¶

Creates or updates the subscription of specified user to the specified product.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
sid (str) – Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
parameters (SubscriptionCreateParameters) – Create parameters.
notify (bool) –
Notify change in Subscription State.
- If false, do not send any email notification for change of state of subscription
- If true, send email notification of change of state of subscription.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.
app_type (str or AppType) – Determines the type of application which send the create user request. Default is legacy publisher portal.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SubscriptionContract, or the result of cls(response)

Return type

SubscriptionContract

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, sid: str, if_match: str, **kwargs: Any) → None [source]¶

Deletes the specified subscription.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
sid (str) – Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, sid: str, **kwargs: Any) → ’_models.SubscriptionContract’[source]¶

Gets the specified Subscription entity.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
sid (str) – Subscription entity Identifier. The entity represents the association between a user and a product in API Management.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SubscriptionContract, or the result of cls(response)

Return type

SubscriptionContract

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, sid: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the apimanagement subscription specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
sid (str) – Subscription entity Identifier. The entity represents the association between a user and a product in API Management.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[SubscriptionCollection]

Raises

~azure.core.exceptions.HttpResponseError

list(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.SubscriptionCollection’][source]¶

Lists all subscriptions of the API Management service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || state | filter | eq | || user | expand | | |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SubscriptionCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_secrets(resource_group_name: str, service_name: str, sid: str, **kwargs: Any) → ’_models.SubscriptionKeysContract’[source]¶

Gets the specified Subscription keys.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
sid (str) – Subscription entity Identifier. The entity represents the association between a user and a product in API Management.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SubscriptionKeysContract, or the result of cls(response)

Return type

SubscriptionKeysContract

Raises

~azure.core.exceptions.HttpResponseError

regenerate_primary_key(resource_group_name: str, service_name: str, sid: str, **kwargs: Any) → None [source]¶

Regenerates primary key of existing subscription of the API Management service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
sid (str) – Subscription entity Identifier. The entity represents the association between a user and a product in API Management.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

regenerate_secondary_key(resource_group_name: str, service_name: str, sid: str, **kwargs: Any) → None [source]¶

Regenerates secondary key of existing subscription of the API Management service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
sid (str) – Subscription entity Identifier. The entity represents the association between a user and a product in API Management.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, sid: str, if_match: str, parameters: ‘_models.SubscriptionUpdateParameters’, notify: Optional[bool] = None, app_type: Optional[Union[str, ‘_models.AppType’]] = None, **kwargs: Any) → ’_models.SubscriptionContract’[source]¶

Updates the details of a subscription specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
sid (str) – Subscription entity Identifier. The entity represents the association between a user and a product in API Management.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (SubscriptionUpdateParameters) – Update parameters.
notify (bool) –
Notify change in Subscription State.
- If false, do not send any email notification for change of state of subscription
- If true, send email notification of change of state of subscription.
app_type (str or AppType) – Determines the type of application which send the create user request. Default is legacy publisher portal.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SubscriptionContract, or the result of cls(response)

Return type

SubscriptionContract

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.TagResourceOperations(client, config, serializer, deserializer)[source]¶

Bases: object

TagResourceOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.TagResourceCollection’][source]¶

Lists a collection of resources associated with tags.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| aid | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || apiName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || state | filter | eq | || isCurrent | filter | eq | |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either TagResourceCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.TenantAccessOperations(client, config, serializer, deserializer)[source]¶

Bases: object

TenantAccessOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_group_name: str, service_name: str, access_name: Union[str, ‘_models.AccessIdName’], **kwargs: Any) → ’_models.AccessInformationContract’[source]¶

Get tenant access information details without secrets.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
access_name (str or AccessIdName) – The identifier of the Access configuration.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AccessInformationContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, access_name: Union[str, ‘_models.AccessIdName’], **kwargs: Any) → bool [source]¶

Tenant access metadata.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
access_name (str or AccessIdName) – The identifier of the Access configuration.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_secrets(resource_group_name: str, service_name: str, access_name: Union[str, ‘_models.AccessIdName’], **kwargs: Any) → ’_models.AccessInformationContract’[source]¶

Get tenant access information details.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
access_name (str or AccessIdName) – The identifier of the Access configuration.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AccessInformationContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

regenerate_primary_key(resource_group_name: str, service_name: str, access_name: Union[str, ‘_models.AccessIdName’], **kwargs: Any) → None [source]¶

Regenerate primary access key.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
access_name (str or AccessIdName) – The identifier of the Access configuration.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

regenerate_secondary_key(resource_group_name: str, service_name: str, access_name: Union[str, ‘_models.AccessIdName’], **kwargs: Any) → None [source]¶

Regenerate secondary access key.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
access_name (str or AccessIdName) – The identifier of the Access configuration.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, access_name: Union[str, ‘_models.AccessIdName’], if_match: str, parameters: ‘_models.AccessInformationUpdateParameters’, **kwargs: Any) → ’_models.AccessInformationContract’[source]¶

Update tenant access information details.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
access_name (str or AccessIdName) – The identifier of the Access configuration.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (AccessInformationUpdateParameters) – Parameters supplied to retrieve the Tenant Access Information.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AccessInformationContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.TenantAccessGitOperations(client, config, serializer, deserializer)[source]¶

Bases: object

TenantAccessGitOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

get(resource_group_name: str, service_name: str, access_name: Union[str, ‘_models.AccessIdName’], **kwargs: Any) → ’_models.AccessInformationContract’[source]¶

Gets the Git access configuration for the tenant. Without secrets.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
access_name (str or AccessIdName) – The identifier of the Access configuration.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AccessInformationContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

list_secrets(resource_group_name: str, service_name: str, access_name: Union[str, ‘_models.AccessIdName’], **kwargs: Any) → ’_models.AccessInformationContract’[source]¶

Gets the Git access configuration for the tenant.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
access_name (str or AccessIdName) – The identifier of the Access configuration.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AccessInformationContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

regenerate_primary_key(resource_group_name: str, service_name: str, access_name: Union[str, ‘_models.AccessIdName’], **kwargs: Any) → None [source]¶

Regenerate primary access key for GIT.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
access_name (str or AccessIdName) – The identifier of the Access configuration.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

regenerate_secondary_key(resource_group_name: str, service_name: str, access_name: Union[str, ‘_models.AccessIdName’], **kwargs: Any) → None [source]¶

Regenerate secondary access key for GIT.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
access_name (str or AccessIdName) – The identifier of the Access configuration.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

LROPoller[OperationResultContract]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.TenantConfigurationOperations(client, config, serializer, deserializer)[source]¶

Bases: object

TenantConfigurationOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

begin_deploy(resource_group_name: str, service_name: str, configuration_name: Union[str, ‘_models.ConfigurationIdName’], parameters: ‘_models.DeployConfigurationParameters’, **kwargs: Any) → LROPoller[‘_models.OperationResultContract’][source]¶

This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
configuration_name (str or ConfigurationIdName) – The identifier of the Git Configuration Operation.
parameters (DeployConfigurationParameters) – Deploy Configuration parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either OperationResultContract or the result of cls(response)

Return type

Raises

LROPoller[OperationResultContract]

begin_save(resource_group_name: str, service_name: str, configuration_name: Union[str, ‘_models.ConfigurationIdName’], parameters: ‘_models.SaveConfigurationParameter’, **kwargs: Any) → LROPoller[‘_models.OperationResultContract’][source]¶

This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
configuration_name (str or ConfigurationIdName) – The identifier of the Git Configuration Operation.
parameters (SaveConfigurationParameter) – Save Configuration parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either OperationResultContract or the result of cls(response)

Return type

Raises

LROPoller[OperationResultContract]

begin_validate(resource_group_name: str, service_name: str, configuration_name: Union[str, ‘_models.ConfigurationIdName’], parameters: ‘_models.DeployConfigurationParameters’, **kwargs: Any) → LROPoller[‘_models.OperationResultContract’][source]¶

This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
configuration_name (str or ConfigurationIdName) – The identifier of the Git Configuration Operation.
parameters (DeployConfigurationParameters) – Validate Configuration parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response
continuation_token (str) – A continuation token to restart a poller from a saved state.
polling (bool or PollingMethod) – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of LROPoller that returns either OperationResultContract or the result of cls(response)

Return type

Raises

TenantConfigurationSyncStateContract

get_sync_state(resource_group_name: str, service_name: str, configuration_name: Union[str, ‘_models.ConfigurationIdName’], **kwargs: Any) → ’_models.TenantConfigurationSyncStateContract’[source]¶

Gets the status of the most recent synchronization between the configuration database and the Git repository.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
configuration_name (str or ConfigurationIdName) – The identifier of the Git Configuration Operation.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

TenantConfigurationSyncStateContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.UserOperations(client, config, serializer, deserializer)[source]¶

Bases: object

UserOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

create_or_update(resource_group_name: str, service_name: str, user_id: str, parameters: ‘_models.UserCreateParameters’, notify: Optional[bool] = None, if_match: Optional[str] = None, **kwargs: Any) → ’_models.UserContract’[source]¶

Creates or Updates a user.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
user_id (str) – User identifier. Must be unique in the current API Management service instance.
parameters (UserCreateParameters) – Create or update parameters.
notify (bool) – Send an Email notification to the User.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

UserContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

delete(resource_group_name: str, service_name: str, user_id: str, if_match: str, delete_subscriptions: Optional[bool] = None, notify: Optional[bool] = None, app_type: Optional[Union[str, ‘_models.AppType’]] = None, **kwargs: Any) → None [source]¶

Deletes specific user.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
user_id (str) – User identifier. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
delete_subscriptions (bool) – Whether to delete user’s subscription or not.
notify (bool) – Send an Account Closed Email notification to the User.
app_type (str or AppType) – Determines the type of application which send the create user request. Default is legacy publisher portal.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

generate_sso_url(resource_group_name: str, service_name: str, user_id: str, **kwargs: Any) → ’_models.GenerateSsoUrlResult’[source]¶

Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
user_id (str) – User identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

GenerateSsoUrlResult, or the result of cls(response)

Return type

GenerateSsoUrlResult

Raises

~azure.core.exceptions.HttpResponseError

get(resource_group_name: str, service_name: str, user_id: str, **kwargs: Any) → ’_models.UserContract’[source]¶

Gets the details of the user specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
user_id (str) – User identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

UserContract, or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

get_entity_tag(resource_group_name: str, service_name: str, user_id: str, **kwargs: Any) → bool [source]¶

Gets the entity state (Etag) version of the user specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
user_id (str) – User identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

bool, or the result of cls(response)

Return type

ItemPaged[UserCollection]

Raises

~azure.core.exceptions.HttpResponseError

get_shared_access_token(resource_group_name: str, service_name: str, user_id: str, parameters: ‘_models.UserTokenParameters’, **kwargs: Any) → ’_models.UserTokenResult’[source]¶

Gets the Shared Access Authorization Token for the User.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
user_id (str) – User identifier. Must be unique in the current API Management service instance.
parameters (UserTokenParameters) – Create Authorization Token parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

UserTokenResult, or the result of cls(response)

Return type

UserTokenResult

Raises

~azure.core.exceptions.HttpResponseError

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, expand_groups: Optional[bool] = None, **kwargs: Any) → Iterable[‘_models.UserCollection’][source]¶

Lists a collection of registered users in the specified service instance.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|-------------|————-|-------------|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || state | filter | eq | || registrationDate | filter | ge, le, eq, ne, gt, lt | || note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || groups | expand | | |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.
expand_groups (bool) – Detailed Group in response.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either UserCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

update(resource_group_name: str, service_name: str, user_id: str, if_match: str, parameters: ‘_models.UserUpdateParameters’, **kwargs: Any) → ’_models.UserContract’[source]¶

Updates the details of the user specified by its identifier.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
user_id (str) – User identifier. Must be unique in the current API Management service instance.
if_match (str) – ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
parameters (UserUpdateParameters) – Update parameters.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

UserContract, or the result of cls(response)

Return type

ItemPaged[GroupCollection]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.UserGroupOperations(client, config, serializer, deserializer)[source]¶

Bases: object

UserGroupOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(resource_group_name: str, service_name: str, user_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.GroupCollection’][source]¶

Lists all user groups.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
user_id (str) – User identifier. Must be unique in the current API Management service instance.
filter (str) –

Field | Usage | Supported operators | Supported

functions ||————-|------------------------|———————————–|| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith || description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either GroupCollection or the result of cls(response)

Return type

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.UserSubscriptionOperations(client, config, serializer, deserializer)[source]¶

Bases: object

UserSubscriptionOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(resource_group_name: str, service_name: str, user_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[‘_models.SubscriptionCollection’][source]¶

Lists the collection of subscriptions of the specified user.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
user_id (str) – User identifier. Must be unique in the current API Management service instance.
filter (str) –

Field | Usage | Supported operators | Supported functions

||————-|------------------------|———————————–||name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith ||displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith ||stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith ||ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith ||scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith ||userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith ||productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |.
top (int) – Number of records to return.
skip (int) – Number of records to skip.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either SubscriptionCollection or the result of cls(response)

Return type

ItemPaged[SubscriptionCollection]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.UserIdentitiesOperations(client, config, serializer, deserializer)[source]¶

Bases: object

UserIdentitiesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

list(resource_group_name: str, service_name: str, user_id: str, **kwargs: Any) → Iterable[‘_models.UserIdentityCollection’][source]¶

List of all user identities.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
user_id (str) – User identifier. Must be unique in the current API Management service instance.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

An iterator like instance of either UserIdentityCollection or the result of cls(response)

Return type

ItemPaged[UserIdentityCollection]

Raises

~azure.core.exceptions.HttpResponseError

models = <module 'azure.mgmt.apimanagement.models' from '/home/vsts/work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.6/site-packages/azure/mgmt/apimanagement/models/__init__.py'>¶

class azure.mgmt.apimanagement.operations.UserConfirmationPasswordOperations(client, config, serializer, deserializer)[source]¶

Bases: object

UserConfirmationPasswordOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Variables

models – Alias to model classes used in this operation group.

Parameters

client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.

send(resource_group_name: str, service_name: str, user_id: str, app_type: Optional[Union[str, ‘_models.AppType’]] = None, **kwargs: Any) → None [source]¶

Sends confirmation.

Parameters

resource_group_name (str) – The name of the resource group.
service_name (str) – The name of the API Management service.
user_id (str) – User identifier. Must be unique in the current API Management service instance.
app_type (str or AppType) – Determines the type of application which send the create user request. Default is legacy publisher portal.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None, or the result of cls(response)

Return type