azure.mgmt.apimanagement.operations module¶
-
class
azure.mgmt.apimanagement.operations.
ApiOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ApiOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, api_id, parameters, if_match=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates new or updates existing 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.
parameters (ApiCreateOrUpdateParameter) – Create or update parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ApiContract or ClientRawResponse<ApiContract> if raw==True
- Return type
AzureOperationPoller[ApiContract] or AzureOperationPoller[ClientRawResponse[ApiContract]]
- Raises
-
delete
(resource_group_name, service_name, api_id, if_match, delete_revisions=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, api_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ApiContract or ClientRawResponse if raw=true
- Return type
ApiContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, api_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, filter=None, top=None, skip=None, tags=None, expand_api_version_set=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
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
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ApiContract
- Return type
- Raises
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 | Supported operators | Supportedfunctions | |-------------|————————|-----------------------------------| |name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |displayName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |apiRevision | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |isCurrent | eq | |
top (int) – Number of records to return.
skip (int) – Number of records to skip.
include_not_tagged_apis (bool) – Include not tagged APIs.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of TagResourceContract
- Return type
- Raises
-
update
(resource_group_name, service_name, api_id, parameters, if_match, custom_headers=None, raw=False, **operation_config)[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.
parameters (ApiUpdateContract) – API Update Contract parameters.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
list_by_service
(resource_group_name, service_name, api_id, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ApiRevisionContract
- Return type
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, api_id, release_id, if_match=None, api_id1=None, notes=None, custom_headers=None, raw=False, **operation_config)[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.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.
api_id1 (str) – Identifier of the API the release belongs to.
notes (str) – Release Notes
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ApiReleaseContract or ClientRawResponse if raw=true
- Return type
ApiReleaseContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, api_id, release_id, if_match, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, api_id, release_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ApiReleaseContract or ClientRawResponse if raw=true
- Return type
ApiReleaseContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, api_id, release_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, api_id, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| notes | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ApiReleaseContract
- Return type
- Raises
-
update
(resource_group_name, service_name, api_id, release_id, if_match, api_id1=None, notes=None, custom_headers=None, raw=False, **operation_config)[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.
api_id1 (str) – Identifier of the API the release belongs to.
notes (str) – Release Notes
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, api_id, operation_id, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
OperationContract or ClientRawResponse if raw=true
- Return type
OperationContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, api_id, operation_id, if_match, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, api_id, operation_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
OperationContract or ClientRawResponse if raw=true
- Return type
OperationContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, api_id, operation_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_api
(resource_group_name, service_name, api_id, filter=None, top=None, skip=None, tags=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
tags (str) – Include tags in the response.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of OperationContract
- Return type
- Raises
-
update
(resource_group_name, service_name, api_id, operation_id, parameters, if_match, custom_headers=None, raw=False, **operation_config)[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.
parameters (OperationUpdateContract) – API Operation Update parameters.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
policy_id – The identifier of the Policy. Constant value: “policy”.
-
create_or_update
(resource_group_name, service_name, api_id, operation_id, value, if_match=None, format='xml', custom_headers=None, raw=False, **operation_config)[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.
value (str) – Contents of the Policy as defined by the format.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.
format (str or PolicyContentFormat) – Format of the policyContent. Possible values include: ‘xml’, ‘xml-link’, ‘rawxml’, ‘rawxml-link’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PolicyContract or ClientRawResponse if raw=true
- Return type
PolicyContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, api_id, operation_id, if_match, custom_headers=None, raw=False, **operation_config)[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.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, api_id, operation_id, format='xml', custom_headers=None, raw=False, **operation_config)[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.
format (str or PolicyExportFormat) – Policy Export Format. Possible values include: ‘xml’, ‘rawxml’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PolicyContract or ClientRawResponse if raw=true
- Return type
PolicyContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, api_id, operation_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_operation
(resource_group_name, service_name, api_id, operation_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PolicyCollection or ClientRawResponse if raw=true
- Return type
PolicyCollection or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
assign_to_api
(resource_group_name, service_name, api_id, tag_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
TagContract or ClientRawResponse if raw=true
- Return type
TagContract or ClientRawResponse
- Raises
-
assign_to_operation
(resource_group_name, service_name, api_id, operation_id, tag_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
TagContract or ClientRawResponse if raw=true
- Return type
TagContract or ClientRawResponse
- Raises
-
assign_to_product
(resource_group_name, service_name, product_id, tag_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
TagContract or ClientRawResponse if raw=true
- Return type
TagContract or ClientRawResponse
- Raises
-
create_or_update
(resource_group_name, service_name, tag_id, display_name, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
display_name (str) – Tag name.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
TagContract or ClientRawResponse if raw=true
- Return type
TagContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, tag_id, if_match, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
detach_from_api
(resource_group_name, service_name, api_id, tag_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
detach_from_operation
(resource_group_name, service_name, api_id, operation_id, tag_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
detach_from_product
(resource_group_name, service_name, product_id, tag_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, tag_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
TagContract or ClientRawResponse if raw=true
- Return type
TagContract or ClientRawResponse
- Raises
-
get_by_api
(resource_group_name, service_name, api_id, tag_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
TagContract or ClientRawResponse if raw=true
- Return type
TagContract or ClientRawResponse
- Raises
-
get_by_operation
(resource_group_name, service_name, api_id, operation_id, tag_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
TagContract or ClientRawResponse if raw=true
- Return type
TagContract or ClientRawResponse
- Raises
-
get_by_product
(resource_group_name, service_name, product_id, tag_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
TagContract or ClientRawResponse if raw=true
- Return type
TagContract or ClientRawResponse
- Raises
-
get_entity_state
(resource_group_name, service_name, tag_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get_entity_state_by_api
(resource_group_name, service_name, api_id, tag_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get_entity_state_by_operation
(resource_group_name, service_name, api_id, operation_id, tag_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get_entity_state_by_product
(resource_group_name, service_name, product_id, tag_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_api
(resource_group_name, service_name, api_id, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of TagContract
- Return type
- Raises
-
list_by_operation
(resource_group_name, service_name, api_id, operation_id, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of TagContract
- Return type
- Raises
-
list_by_product
(resource_group_name, service_name, product_id, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of TagContract
- Return type
- Raises
-
list_by_service
(resource_group_name, service_name, filter=None, top=None, skip=None, scope=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
scope (str) – Scope like ‘apis’, ‘products’ or ‘apis/{apiId}
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of TagContract
- Return type
- Raises
-
update
(resource_group_name, service_name, tag_id, if_match, display_name, custom_headers=None, raw=False, **operation_config)[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.
display_name (str) – Tag name.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
list_by_apis
(resource_group_name, service_name, api_id, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ProductContract
- Return type
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
policy_id – The identifier of the Policy. Constant value: “policy”.
-
create_or_update
(resource_group_name, service_name, api_id, value, if_match=None, format='xml', custom_headers=None, raw=False, **operation_config)[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.
value (str) – Contents of the Policy as defined by the format.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.
format (str or PolicyContentFormat) – Format of the policyContent. Possible values include: ‘xml’, ‘xml-link’, ‘rawxml’, ‘rawxml-link’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PolicyContract or ClientRawResponse if raw=true
- Return type
PolicyContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, api_id, if_match, custom_headers=None, raw=False, **operation_config)[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.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, api_id, format='xml', custom_headers=None, raw=False, **operation_config)[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.
format (str or PolicyExportFormat) – Policy Export Format. Possible values include: ‘xml’, ‘rawxml’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PolicyContract or ClientRawResponse if raw=true
- Return type
PolicyContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, api_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_api
(resource_group_name, service_name, api_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PolicyCollection or ClientRawResponse if raw=true
- Return type
PolicyCollection or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, api_id, schema_id, parameters, if_match=None, custom_headers=None, raw=False, polling=True, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns SchemaContract or ClientRawResponse<SchemaContract> if raw==True
- Return type
AzureOperationPoller[SchemaContract] or AzureOperationPoller[ClientRawResponse[SchemaContract]]
- Raises
-
delete
(resource_group_name, service_name, api_id, schema_id, if_match, force=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, api_id, schema_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
SchemaContract or ClientRawResponse if raw=true
- Return type
SchemaContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, api_id, schema_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_api
(resource_group_name, service_name, api_id, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| contentType | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of SchemaContract
- Return type
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, api_id, diagnostic_id, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DiagnosticContract or ClientRawResponse if raw=true
- Return type
DiagnosticContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, api_id, diagnostic_id, if_match, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, api_id, diagnostic_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DiagnosticContract or ClientRawResponse if raw=true
- Return type
DiagnosticContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, api_id, diagnostic_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, api_id, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of DiagnosticContract
- Return type
- Raises
-
update
(resource_group_name, service_name, api_id, diagnostic_id, parameters, if_match, custom_headers=None, raw=False, **operation_config)[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.
parameters (DiagnosticContract) – Diagnostic Update parameters.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, api_id, issue_id, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IssueContract or ClientRawResponse if raw=true
- Return type
IssueContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, api_id, issue_id, if_match, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, api_id, issue_id, expand_comments_attachments=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IssueContract or ClientRawResponse if raw=true
- Return type
IssueContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, api_id, issue_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, api_id, filter=None, expand_comments_attachments=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| state | filter | eq | | </br>
expand_comments_attachments (bool) – Expand the comment attachments.
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of IssueContract
- Return type
- Raises
-
update
(resource_group_name, service_name, api_id, issue_id, parameters, if_match, custom_headers=None, raw=False, **operation_config)[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.
parameters (IssueUpdateContract) – Update parameters.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, api_id, issue_id, comment_id, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IssueCommentContract or ClientRawResponse if raw=true
- Return type
IssueCommentContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, api_id, issue_id, comment_id, if_match, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, api_id, issue_id, comment_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IssueCommentContract or ClientRawResponse if raw=true
- Return type
IssueCommentContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, api_id, issue_id, comment_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, api_id, issue_id, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of IssueCommentContract
- Return type
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, api_id, issue_id, attachment_id, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IssueAttachmentContract or ClientRawResponse if raw=true
- Return type
IssueAttachmentContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, api_id, issue_id, attachment_id, if_match, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, api_id, issue_id, attachment_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IssueAttachmentContract or ClientRawResponse if raw=true
- Return type
IssueAttachmentContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, api_id, issue_id, attachment_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, api_id, issue_id, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of IssueAttachmentContract
- Return type
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, api_id, tag_description_id, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
TagDescriptionContract or ClientRawResponse if raw=true
- Return type
TagDescriptionContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, api_id, tag_description_id, if_match, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, api_id, tag_description_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
TagDescriptionContract or ClientRawResponse if raw=true
- Return type
TagDescriptionContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, api_id, tag_description_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, api_id, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of TagDescriptionContract
- Return type
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| apiName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
include_not_tagged_operations (bool) – Include not tagged Operations.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of TagResourceContract
- Return type
- Raises
CloudError
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, version_set_id, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ApiVersionSetContract or ClientRawResponse if raw=true
- Return type
ApiVersionSetContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, version_set_id, if_match, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, version_set_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ApiVersionSetContract or ClientRawResponse if raw=true
- Return type
ApiVersionSetContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, version_set_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|————-|</br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ApiVersionSetContract
- Return type
- Raises
-
update
(resource_group_name, service_name, version_set_id, parameters, if_match, custom_headers=None, raw=False, **operation_config)[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.
parameters (ApiVersionSetUpdateParameters) – Update parameters.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, authsid, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
AuthorizationServerContract or ClientRawResponse if raw=true
- Return type
AuthorizationServerContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, authsid, if_match, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, authsid, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
AuthorizationServerContract or ClientRawResponse if raw=true
- Return type
AuthorizationServerContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, authsid, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of AuthorizationServerContract
- Return type
AuthorizationServerContractPaged[AuthorizationServerContract]
- Raises
-
list_secrets
(resource_group_name, service_name, authsid, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ClientSecretContract or ClientRawResponse if raw=true
- Return type
ClientSecretContract or ClientRawResponse
- Raises
-
update
(resource_group_name, service_name, authsid, parameters, if_match, custom_headers=None, raw=False, **operation_config)[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.
parameters (AuthorizationServerUpdateContract) – OAuth2 Server settings Update parameters.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, backend_id, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
BackendContract or ClientRawResponse if raw=true
- Return type
BackendContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, backend_id, if_match, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, backend_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
BackendContract or ClientRawResponse if raw=true
- Return type
BackendContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, backend_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| url | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of BackendContract
- Return type
- Raises
-
reconnect
(resource_group_name, service_name, backend_id, after=None, custom_headers=None, raw=False, **operation_config)[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.
after (timedelta) – Duration in ISO8601 format after which reconnect will be initiated. Minimum duration of the Reconnect is PT2M.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
update
(resource_group_name, service_name, backend_id, parameters, if_match, custom_headers=None, raw=False, **operation_config)[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.
parameters (BackendUpdateParameters) – Update parameters.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, cache_id, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
CacheContract or ClientRawResponse if raw=true
- Return type
CacheContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, cache_id, if_match, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, cache_id, custom_headers=None, raw=False, **operation_config)[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).
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
CacheContract or ClientRawResponse if raw=true
- Return type
CacheContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, cache_id, custom_headers=None, raw=False, **operation_config)[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).
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of CacheContract
- Return type
- Raises
-
update
(resource_group_name, service_name, cache_id, parameters, if_match, custom_headers=None, raw=False, **operation_config)[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).
parameters (CacheUpdateParameters) – Update parameters.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, certificate_id, data, password, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
data (str) – Base 64 encoded certificate using the application/x-pkcs12 representation.
password (str) – Password for the Certificate
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
CertificateContract or ClientRawResponse if raw=true
- Return type
CertificateContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, certificate_id, if_match, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, certificate_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
CertificateContract or ClientRawResponse if raw=true
- Return type
CertificateContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, certificate_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| subject | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| thumbprint | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| expirationDate | filter | ge, le, eq, ne, gt, lt | | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of CertificateContract
- Return type
- Raises
-
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.
ApiManagementOperations
(client, config, serializer, deserializer)[source]¶ Bases:
object
ApiManagementOperations operations.
You should not instantiate directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all of the available REST API operations of the Microsoft.ApiManagement provider.
- Parameters
- Returns
An iterator like instance of Operation
- Return type
- Raises
CloudError
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
list_available_service_skus
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ResourceSkuResult
- Return type
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
apply_network_configuration_updates
(resource_group_name, service_name, location=None, custom_headers=None, raw=False, polling=True, **operation_config)[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.
location (str) – Location of the Api Management service to update for a multi-region service. For a service deployed in a single region, this parameter is not required.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ApiManagementServiceResource or ClientRawResponse<ApiManagementServiceResource> if raw==True
- Return type
AzureOperationPoller[ApiManagementServiceResource] or AzureOperationPoller[ClientRawResponse[ApiManagementServiceResource]]
- Raises
-
backup
(resource_group_name, service_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ApiManagementServiceResource or ClientRawResponse<ApiManagementServiceResource> if raw==True
- Return type
AzureOperationPoller[ApiManagementServiceResource] or AzureOperationPoller[ClientRawResponse[ApiManagementServiceResource]]
- Raises
-
check_name_availability
(name, custom_headers=None, raw=False, **operation_config)[source]¶ Checks availability and correctness of a name for an API Management service.
- Parameters
- Returns
ApiManagementServiceNameAvailabilityResult or ClientRawResponse if raw=true
- Return type
ApiManagementServiceNameAvailabilityResult or ClientRawResponse
- Raises
-
create_or_update
(resource_group_name, service_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ApiManagementServiceResource or ClientRawResponse<ApiManagementServiceResource> if raw==True
- Return type
AzureOperationPoller[ApiManagementServiceResource] or AzureOperationPoller[ClientRawResponse[ApiManagementServiceResource]]
- Raises
-
delete
(resource_group_name, service_name, custom_headers=None, raw=False, polling=True, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ApiManagementServiceResource or ClientRawResponse<ApiManagementServiceResource> if raw==True
- Return type
AzureOperationPoller[ApiManagementServiceResource] or AzureOperationPoller[ClientRawResponse[ApiManagementServiceResource]]
- Raises
-
get
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ApiManagementServiceResource or ClientRawResponse if raw=true
- Return type
ApiManagementServiceResource or ClientRawResponse
- Raises
-
get_sso_token
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ApiManagementServiceGetSsoTokenResult or ClientRawResponse if raw=true
- Return type
ApiManagementServiceGetSsoTokenResult or ClientRawResponse
- Raises
-
list
(custom_headers=None, raw=False, **operation_config)[source]¶ Lists all API Management services within an Azure subscription.
- Parameters
- Returns
An iterator like instance of ApiManagementServiceResource
- Return type
ApiManagementServiceResourcePaged[ApiManagementServiceResource]
- Raises
CloudError
-
list_by_resource_group
(resource_group_name, custom_headers=None, raw=False, **operation_config)[source]¶ List all API Management services within a resource group.
- Parameters
- Returns
An iterator like instance of ApiManagementServiceResource
- Return type
ApiManagementServiceResourcePaged[ApiManagementServiceResource]
- Raises
-
restore
(resource_group_name, service_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ApiManagementServiceResource or ClientRawResponse<ApiManagementServiceResource> if raw==True
- Return type
AzureOperationPoller[ApiManagementServiceResource] or AzureOperationPoller[ClientRawResponse[ApiManagementServiceResource]]
- Raises
-
update
(resource_group_name, service_name, parameters, custom_headers=None, raw=False, polling=True, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns ApiManagementServiceResource or ClientRawResponse<ApiManagementServiceResource> if raw==True
- Return type
AzureOperationPoller[ApiManagementServiceResource] or AzureOperationPoller[ClientRawResponse[ApiManagementServiceResource]]
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, diagnostic_id, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DiagnosticContract or ClientRawResponse if raw=true
- Return type
DiagnosticContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, diagnostic_id, if_match, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, diagnostic_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
DiagnosticContract or ClientRawResponse if raw=true
- Return type
DiagnosticContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, diagnostic_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of DiagnosticContract
- Return type
- Raises
-
update
(resource_group_name, service_name, diagnostic_id, parameters, if_match, custom_headers=None, raw=False, **operation_config)[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.
parameters (DiagnosticContract) – Diagnostic Update parameters.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, template_name, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
EmailTemplateContract or ClientRawResponse if raw=true
- Return type
EmailTemplateContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, template_name, if_match, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, template_name, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
EmailTemplateContract or ClientRawResponse if raw=true
- Return type
EmailTemplateContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, template_name, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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.
filter (str) –
Field | Usage | Supported operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of EmailTemplateContract
- Return type
- Raises
-
update
(resource_group_name, service_name, template_name, parameters, if_match, custom_headers=None, raw=False, **operation_config)[source]¶ Updates the specific 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. Possible values include: ‘applicationApprovedNotificationMessage’, ‘accountClosedDeveloper’, ‘quotaLimitApproachingDeveloperNotificationMessage’, ‘newDeveloperNotificationMessage’, ‘emailChangeIdentityDefault’, ‘inviteUserNotificationMessage’, ‘newCommentNotificationMessage’, ‘confirmSignUpIdentityDefault’, ‘newIssueNotificationMessage’, ‘purchaseDeveloperNotificationMessage’, ‘passwordResetIdentityDefault’, ‘passwordResetByAdminNotificationMessage’, ‘rejectDeveloperNotificationMessage’, ‘requestDeveloperNotificationMessage’
parameters (EmailTemplateUpdateParameters) – Update parameters.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, gateway_id, if_match=None, location_data=None, description=None, custom_headers=None, raw=False, **operation_config)[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’
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.
location_data (ResourceLocationDataContract) – Gateway location.
description (str) – Gateway description
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
GatewayContract or ClientRawResponse if raw=true
- Return type
GatewayContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, gateway_id, if_match, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
generate_token
(resource_group_name, service_name, gateway_id, expiry, key_type='primary', custom_headers=None, raw=False, **operation_config)[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’
key_type (str or KeyType) – The Key to be used to generate gateway token. Possible values include: ‘primary’, ‘secondary’
expiry (datetime) – The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
GatewayTokenContract or ClientRawResponse if raw=true
- Return type
GatewayTokenContract or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, gateway_id, custom_headers=None, raw=False, **operation_config)[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’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
GatewayContract or ClientRawResponse if raw=true
- Return type
GatewayContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, gateway_id, custom_headers=None, raw=False, **operation_config)[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’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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.
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of GatewayContract
- Return type
- Raises
-
list_keys
(resource_group_name, service_name, gateway_id, custom_headers=None, raw=False, **operation_config)[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’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
GatewayKeysContract or ClientRawResponse if raw=true
- Return type
GatewayKeysContract or ClientRawResponse
- Raises
-
regenerate_key
(resource_group_name, service_name, gateway_id, key_type, custom_headers=None, raw=False, **operation_config)[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’
key_type (str or KeyType) – The Key being regenerated. Possible values include: ‘primary’, ‘secondary’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
update
(resource_group_name, service_name, gateway_id, if_match, location_data=None, description=None, custom_headers=None, raw=False, **operation_config)[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.
location_data (ResourceLocationDataContract) – Gateway location.
description (str) – Gateway description
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, gateway_id, hc_id, parameters, custom_headers=None, raw=False, **operation_config)[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) –
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
GatewayHostnameConfigurationContract or ClientRawResponse if raw=true
- Return type
GatewayHostnameConfigurationContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, gateway_id, hc_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, gateway_id, hc_id, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the details of the Gateway hostname configuration 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’
hc_id (str) – Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
GatewayHostnameConfigurationContract or ClientRawResponse if raw=true
- Return type
GatewayHostnameConfigurationContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, gateway_id, hc_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, gateway_id, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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’
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of GatewayHostnameConfigurationContract
- Return type
GatewayHostnameConfigurationContractPaged[GatewayHostnameConfigurationContract]
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, gateway_id, api_id, provisioning_state=None, custom_headers=None, raw=False, **operation_config)[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.
provisioning_state (str or ProvisioningState) – Provisioning state. Possible values include: ‘created’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ApiContract or ClientRawResponse if raw=true
- Return type
ApiContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, gateway_id, api_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, gateway_id, api_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, gateway_id, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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’
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ApiContract
- Return type
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, group_id, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
GroupContract or ClientRawResponse if raw=true
- Return type
GroupContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, group_id, if_match, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, group_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
GroupContract or ClientRawResponse if raw=true
- Return type
GroupContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, group_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| aadObjectId | filter | eq | | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of GroupContract
- Return type
- Raises
-
update
(resource_group_name, service_name, group_id, parameters, if_match, custom_headers=None, raw=False, **operation_config)[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.
parameters (GroupUpdateParameters) – Update parameters.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
check_entity_exists
(resource_group_name, service_name, group_id, user_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
bool or ClientRawResponse if raw=true
- Return type
bool or ClientRawResponse
- Raises
-
create
(resource_group_name, service_name, group_id, user_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
UserContract or ClientRawResponse if raw=true
- Return type
UserContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, group_id, user_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list
(resource_group_name, service_name, group_id, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| registrationDate | filter | ge, le, eq, ne, gt, lt | | </br>| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of UserContract
- Return type
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, identity_provider_name, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘facebook’, ‘google’, ‘microsoft’, ‘twitter’, ‘aad’, ‘aadB2C’
parameters (IdentityProviderCreateContract) – Create parameters.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IdentityProviderContract or ClientRawResponse if raw=true
- Return type
IdentityProviderContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, identity_provider_name, if_match, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘facebook’, ‘google’, ‘microsoft’, ‘twitter’, ‘aad’, ‘aadB2C’
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, identity_provider_name, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘facebook’, ‘google’, ‘microsoft’, ‘twitter’, ‘aad’, ‘aadB2C’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IdentityProviderContract or ClientRawResponse if raw=true
- Return type
IdentityProviderContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, identity_provider_name, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘facebook’, ‘google’, ‘microsoft’, ‘twitter’, ‘aad’, ‘aadB2C’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of IdentityProviderContract
- Return type
- Raises
-
list_secrets
(resource_group_name, service_name, identity_provider_name, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘facebook’, ‘google’, ‘microsoft’, ‘twitter’, ‘aad’, ‘aadB2C’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ClientSecretContract or ClientRawResponse if raw=true
- Return type
ClientSecretContract or ClientRawResponse
- Raises
-
update
(resource_group_name, service_name, identity_provider_name, parameters, if_match, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘facebook’, ‘google’, ‘microsoft’, ‘twitter’, ‘aad’, ‘aadB2C’
parameters (IdentityProviderUpdateParameters) – Update parameters.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
get
(resource_group_name, service_name, issue_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
IssueContract or ClientRawResponse if raw=true
- Return type
IssueContract or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| apiId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| title | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| authorName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| state | filter | eq | | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of IssueContract
- Return type
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, logger_id, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
LoggerContract or ClientRawResponse if raw=true
- Return type
LoggerContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, logger_id, if_match, force=None, custom_headers=None, raw=False, **operation_config)[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.
force (bool) – Force deletion even if diagnostic is attached.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, logger_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
LoggerContract or ClientRawResponse if raw=true
- Return type
LoggerContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, logger_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| loggerType | filter | eq | | </br>| resourceId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of LoggerContract
- Return type
- Raises
-
update
(resource_group_name, service_name, logger_id, parameters, if_match, custom_headers=None, raw=False, **operation_config)[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.
parameters (LoggerUpdateContract) – Update parameters.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, named_value_id, parameters, if_match=None, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Creates or updates a NamedValue.
- 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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns NamedValueContract or ClientRawResponse<NamedValueContract> if raw==True
- Return type
AzureOperationPoller[NamedValueContract] or AzureOperationPoller[ClientRawResponse[NamedValueContract]]
- Raises
-
delete
(resource_group_name, service_name, named_value_id, if_match, custom_headers=None, raw=False, **operation_config)[source]¶ Deletes specific NamedValue 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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, named_value_id, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the details of the NamedValue 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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
NamedValueContract or ClientRawResponse if raw=true
- Return type
NamedValueContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, named_value_id, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the entity state (Etag) version of the NamedValue 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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[source]¶ Lists a collection of NamedValues 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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| tags | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of NamedValueContract
- Return type
- Raises
-
list_value
(resource_group_name, service_name, named_value_id, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the secret value of the NamedValue.
- 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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PropertyValueContract or ClientRawResponse if raw=true
- Return type
PropertyValueContract or ClientRawResponse
- Raises
-
update
(resource_group_name, service_name, named_value_id, parameters, if_match, custom_headers=None, raw=False, polling=True, **operation_config)[source]¶ Updates the specific NamedValue.
- 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 (NamedValueUpdateParameters) – Update parameters.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns NamedValueContract or ClientRawResponse<NamedValueContract> if raw==True
- Return type
AzureOperationPoller[NamedValueContract] or AzureOperationPoller[ClientRawResponse[NamedValueContract]]
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
list_by_location
(resource_group_name, service_name, location_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
NetworkStatusContract or ClientRawResponse if raw=true
- Return type
NetworkStatusContract or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
list or ClientRawResponse if raw=true
- Return type
list[NetworkStatusContractByLocation] or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, notification_name, if_match=None, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
NotificationContract or ClientRawResponse if raw=true
- Return type
NotificationContract or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, notification_name, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
NotificationContract or ClientRawResponse if raw=true
- Return type
NotificationContract or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of NotificationContract
- Return type
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
check_entity_exists
(resource_group_name, service_name, notification_name, user_id, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’
user_id (str) – User identifier. Must be unique in the current API Management service instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
bool or ClientRawResponse if raw=true
- Return type
bool or ClientRawResponse
- Raises
-
create_or_update
(resource_group_name, service_name, notification_name, user_id, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’
user_id (str) – User identifier. Must be unique in the current API Management service instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
RecipientUserContract or ClientRawResponse if raw=true
- Return type
RecipientUserContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, notification_name, user_id, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’
user_id (str) – User identifier. Must be unique in the current API Management service instance.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_notification
(resource_group_name, service_name, notification_name, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
RecipientUserCollection or ClientRawResponse if raw=true
- Return type
RecipientUserCollection or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
check_entity_exists
(resource_group_name, service_name, notification_name, email, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’
email (str) – Email identifier.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
bool or ClientRawResponse if raw=true
- Return type
bool or ClientRawResponse
- Raises
-
create_or_update
(resource_group_name, service_name, notification_name, email, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’
email (str) – Email identifier.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
RecipientEmailContract or ClientRawResponse if raw=true
- Return type
RecipientEmailContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, notification_name, email, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’
email (str) – Email identifier.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_notification
(resource_group_name, service_name, notification_name, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘RequestPublisherNotificationMessage’, ‘PurchasePublisherNotificationMessage’, ‘NewApplicationNotificationMessage’, ‘BCC’, ‘NewIssuePublisherNotificationMessage’, ‘AccountClosedPublisher’, ‘QuotaLimitApproachingPublisherNotificationMessage’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
RecipientEmailCollection or ClientRawResponse if raw=true
- Return type
RecipientEmailCollection or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, opid, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
OpenidConnectProviderContract or ClientRawResponse if raw=true
- Return type
OpenidConnectProviderContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, opid, if_match, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, opid, custom_headers=None, raw=False, **operation_config)[source]¶ Gets 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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
OpenidConnectProviderContract or ClientRawResponse if raw=true
- Return type
OpenidConnectProviderContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, opid, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of OpenidConnectProviderContract
- Return type
OpenidConnectProviderContractPaged[OpenidConnectProviderContract]
- Raises
-
list_secrets
(resource_group_name, service_name, opid, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ClientSecretContract or ClientRawResponse if raw=true
- Return type
ClientSecretContract or ClientRawResponse
- Raises
-
update
(resource_group_name, service_name, opid, parameters, if_match, custom_headers=None, raw=False, **operation_config)[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.
parameters (OpenidConnectProviderUpdateContract) – Update parameters.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
policy_id – The identifier of the Policy. Constant value: “policy”.
-
create_or_update
(resource_group_name, service_name, value, if_match=None, format='xml', custom_headers=None, raw=False, **operation_config)[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.
value (str) – Contents of the Policy as defined by the format.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.
format (str or PolicyContentFormat) – Format of the policyContent. Possible values include: ‘xml’, ‘xml-link’, ‘rawxml’, ‘rawxml-link’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PolicyContract or ClientRawResponse if raw=true
- Return type
PolicyContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, if_match, custom_headers=None, raw=False, **operation_config)[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.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, format='xml', custom_headers=None, raw=False, **operation_config)[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.
format (str or PolicyExportFormat) – Policy Export Format. Possible values include: ‘xml’, ‘rawxml’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PolicyContract or ClientRawResponse if raw=true
- Return type
PolicyContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PolicyCollection or ClientRawResponse if raw=true
- Return type
PolicyCollection or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
list_by_service
(resource_group_name, service_name, scope=None, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘Tenant’, ‘Product’, ‘Api’, ‘Operation’, ‘All’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PolicyDescriptionCollection or ClientRawResponse if raw=true
- Return type
PolicyDescriptionCollection or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, if_match=None, enabled=None, custom_headers=None, raw=False, **operation_config)[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.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.
enabled (bool) – Redirect Anonymous users to the Sign-In page.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PortalSigninSettings or ClientRawResponse if raw=true
- Return type
PortalSigninSettings or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PortalSigninSettings or ClientRawResponse if raw=true
- Return type
PortalSigninSettings or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
update
(resource_group_name, service_name, if_match, enabled=None, custom_headers=None, raw=False, **operation_config)[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.
enabled (bool) – Redirect Anonymous users to the Sign-In page.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, if_match=None, enabled=None, terms_of_service=None, custom_headers=None, raw=False, **operation_config)[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.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.
enabled (bool) – Allow users to sign up on a developer portal.
terms_of_service (TermsOfServiceProperties) – Terms of service contract properties.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PortalSignupSettings or ClientRawResponse if raw=true
- Return type
PortalSignupSettings or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PortalSignupSettings or ClientRawResponse if raw=true
- Return type
PortalSignupSettings or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
update
(resource_group_name, service_name, if_match, enabled=None, terms_of_service=None, custom_headers=None, raw=False, **operation_config)[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.
enabled (bool) – Allow users to sign up on a developer portal.
terms_of_service (TermsOfServiceProperties) – Terms of service contract properties.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PortalDelegationSettings or ClientRawResponse if raw=true
- Return type
PortalDelegationSettings or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PortalDelegationSettings or ClientRawResponse if raw=true
- Return type
PortalDelegationSettings or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_secrets
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PortalSettingValidationKeyContract or ClientRawResponse if raw=true
- Return type
PortalSettingValidationKeyContract or ClientRawResponse
- Raises
-
update
(resource_group_name, service_name, parameters, if_match, custom_headers=None, raw=False, **operation_config)[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.
parameters (PortalDelegationSettings) – Update Delegation settings.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, product_id, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ProductContract or ClientRawResponse if raw=true
- Return type
ProductContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, product_id, if_match, delete_subscriptions=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, product_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ProductContract or ClientRawResponse if raw=true
- Return type
ProductContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, product_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, filter=None, top=None, skip=None, expand_groups=None, tags=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| state | filter | eq | | </br>| groups | expand | | | </br>
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ProductContract
- Return type
- Raises
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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| state | filter | eq | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
include_not_tagged_products (bool) – Include not tagged Products.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of TagResourceContract
- Return type
- Raises
-
update
(resource_group_name, service_name, product_id, parameters, if_match, custom_headers=None, raw=False, **operation_config)[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.
parameters (ProductUpdateParameters) – Update parameters.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
check_entity_exists
(resource_group_name, service_name, product_id, api_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
create_or_update
(resource_group_name, service_name, product_id, api_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ApiContract or ClientRawResponse if raw=true
- Return type
ApiContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, product_id, api_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_product
(resource_group_name, service_name, product_id, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ApiContract
- Return type
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
check_entity_exists
(resource_group_name, service_name, product_id, group_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
create_or_update
(resource_group_name, service_name, product_id, group_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
GroupContract or ClientRawResponse if raw=true
- Return type
GroupContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, product_id, group_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_product
(resource_group_name, service_name, product_id, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | | </br>| displayName | filter | eq, ne | | </br>| description | filter | eq, ne | | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of GroupContract
- Return type
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
list
(resource_group_name, service_name, product_id, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| state | filter | eq | | </br>| user | expand | | | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of SubscriptionContract
- Return type
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
policy_id – The identifier of the Policy. Constant value: “policy”.
-
create_or_update
(resource_group_name, service_name, product_id, value, if_match=None, format='xml', custom_headers=None, raw=False, **operation_config)[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.
value (str) – Contents of the Policy as defined by the format.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.
format (str or PolicyContentFormat) – Format of the policyContent. Possible values include: ‘xml’, ‘xml-link’, ‘rawxml’, ‘rawxml-link’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PolicyContract or ClientRawResponse if raw=true
- Return type
PolicyContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, product_id, if_match, custom_headers=None, raw=False, **operation_config)[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.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, product_id, format='xml', custom_headers=None, raw=False, **operation_config)[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.
format (str or PolicyExportFormat) – Policy Export Format. Possible values include: ‘xml’, ‘rawxml’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PolicyContract or ClientRawResponse if raw=true
- Return type
PolicyContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, product_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_by_product
(resource_group_name, service_name, product_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
PolicyCollection or ClientRawResponse if raw=true
- Return type
PolicyCollection or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
list_by_service
(resource_group_name, service_name, quota_counter_key, custom_headers=None, raw=False, **operation_config)[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
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
QuotaCounterCollection or ClientRawResponse if raw=true
- Return type
QuotaCounterCollection or ClientRawResponse
- Raises
-
update
(resource_group_name, service_name, quota_counter_key, calls_count=None, kb_transferred=None, custom_headers=None, raw=False, **operation_config)[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
calls_count (int) – Number of times Counter was called.
kb_transferred (float) – Data Transferred in KiloBytes.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
get
(resource_group_name, service_name, quota_counter_key, quota_period_key, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
QuotaCounterContract or ClientRawResponse if raw=true
- Return type
QuotaCounterContract or ClientRawResponse
- Raises
-
update
(resource_group_name, service_name, quota_counter_key, quota_period_key, calls_count=None, kb_transferred=None, custom_headers=None, raw=False, **operation_config)[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.
calls_count (int) – Number of times Counter was called.
kb_transferred (float) – Data Transferred in KiloBytes.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
list_by_service
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of RegionContract
- Return type
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
list_by_api
(resource_group_name, service_name, filter, top=None, skip=None, orderby=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ReportRecordContract
- Return type
- Raises
CloudError
-
list_by_geo
(resource_group_name, service_name, filter, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| timestamp | filter | ge, le | | </br>| country | select | | | </br>| region | select | | | </br>| zip | select | | | </br>| apiRegion | filter | eq | | </br>| userId | filter | eq | | </br>| productId | filter | eq | | </br>| subscriptionId | filter | eq | | </br>| apiId | filter | eq | | </br>| operationId | filter | eq | | </br>| callCountSuccess | select | | | </br>| callCountBlocked | select | | | </br>| callCountFailed | select | | | </br>| callCountOther | select | | | </br>| bandwidth | select, orderBy | | | </br>| cacheHitsCount | select | | | </br>| cacheMissCount | select | | | </br>| apiTimeAvg | select | | | </br>| apiTimeMin | select | | | </br>| apiTimeMax | select | | | </br>| serviceTimeAvg | select | | | </br>| serviceTimeMin | select | | | </br>| serviceTimeMax | select | | | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ReportRecordContract
- Return type
- Raises
CloudError
-
list_by_operation
(resource_group_name, service_name, filter, top=None, skip=None, orderby=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| timestamp | filter | ge, le | | </br>| displayName | select, orderBy | | | </br>| apiRegion | filter | eq | | </br>| userId | filter | eq | | </br>| productId | filter | eq | | </br>| subscriptionId | filter | eq | | </br>| apiId | filter | eq | | </br>| operationId | select, filter | eq | | </br>| callCountSuccess | select, orderBy | | | </br>| callCountBlocked | select, orderBy | | | </br>| callCountFailed | select, orderBy | | | </br>| callCountOther | select, orderBy | | | </br>| callCountTotal | select, orderBy | | | </br>| bandwidth | select, orderBy | | | </br>| cacheHitsCount | select | | | </br>| cacheMissCount | select | | | </br>| apiTimeAvg | select, orderBy | | | </br>| apiTimeMin | select | | | </br>| apiTimeMax | select | | | </br>| serviceTimeAvg | select | | | </br>| serviceTimeMin | select | | | </br>| serviceTimeMax | select | | | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
orderby (str) – OData order by query option.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ReportRecordContract
- Return type
- Raises
CloudError
-
list_by_product
(resource_group_name, service_name, filter, top=None, skip=None, orderby=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| timestamp | filter | ge, le | | </br>| displayName | select, orderBy | | | </br>| apiRegion | filter | eq | | </br>| userId | filter | eq | | </br>| productId | select, filter | eq | | </br>| subscriptionId | filter | eq | | </br>| callCountSuccess | select, orderBy | | | </br>| callCountBlocked | select, orderBy | | | </br>| callCountFailed | select, orderBy | | | </br>| callCountOther | select, orderBy | | | </br>| callCountTotal | select, orderBy | | | </br>| bandwidth | select, orderBy | | | </br>| cacheHitsCount | select | | | </br>| cacheMissCount | select | | | </br>| apiTimeAvg | select, orderBy | | | </br>| apiTimeMin | select | | | </br>| apiTimeMax | select | | | </br>| serviceTimeAvg | select | | | </br>| serviceTimeMin | select | | | </br>| serviceTimeMax | select | | | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
orderby (str) – OData order by query option.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ReportRecordContract
- Return type
- Raises
CloudError
-
list_by_request
(resource_group_name, service_name, filter, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| timestamp | filter | ge, le | | </br>| apiId | filter | eq | | </br>| operationId | filter | eq | | </br>| productId | filter | eq | | </br>| userId | filter | eq | | </br>| apiRegion | filter | eq | | </br>| subscriptionId | filter | eq | | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of RequestReportRecordContract
- Return type
RequestReportRecordContractPaged[RequestReportRecordContract]
- Raises
CloudError
-
list_by_subscription
(resource_group_name, service_name, filter, top=None, skip=None, orderby=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| timestamp | filter | ge, le | | </br>| displayName | select, orderBy | | | </br>| apiRegion | filter | eq | | </br>| userId | select, filter | eq | | </br>| productId | select, filter | eq | | </br>| subscriptionId | select, filter | eq | | </br>| callCountSuccess | select, orderBy | | | </br>| callCountBlocked | select, orderBy | | | </br>| callCountFailed | select, orderBy | | | </br>| callCountOther | select, orderBy | | | </br>| callCountTotal | select, orderBy | | | </br>| bandwidth | select, orderBy | | | </br>| cacheHitsCount | select | | | </br>| cacheMissCount | select | | | </br>| apiTimeAvg | select, orderBy | | | </br>| apiTimeMin | select | | | </br>| apiTimeMax | select | | | </br>| serviceTimeAvg | select | | | </br>| serviceTimeMin | select | | | </br>| serviceTimeMax | select | | | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
orderby (str) – OData order by query option.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ReportRecordContract
- Return type
- Raises
CloudError
-
list_by_time
(resource_group_name, service_name, filter, interval, top=None, skip=None, orderby=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| timestamp | filter, select | ge, le | | </br>| interval | select | | | </br>| apiRegion | filter | eq | | </br>| userId | filter | eq | | </br>| productId | filter | eq | | </br>| subscriptionId | filter | eq | | </br>| apiId | filter | eq | | </br>| operationId | filter | eq | | </br>| callCountSuccess | select | | | </br>| callCountBlocked | select | | | </br>| callCountFailed | select | | | </br>| callCountOther | select | | | </br>| bandwidth | select, orderBy | | | </br>| cacheHitsCount | select | | | </br>| cacheMissCount | select | | | </br>| apiTimeAvg | select | | | </br>| apiTimeMin | select | | | </br>| apiTimeMax | select | | | </br>| serviceTimeAvg | select | | | </br>| serviceTimeMin | select | | | </br>| serviceTimeMax | select | | | </br>
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ReportRecordContract
- Return type
- Raises
CloudError
-
list_by_user
(resource_group_name, service_name, filter, top=None, skip=None, orderby=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| timestamp | filter | ge, le | | </br>| displayName | select, orderBy | | | </br>| userId | select, filter | eq | | </br>| apiRegion | filter | eq | | </br>| productId | filter | eq | | </br>| subscriptionId | filter | eq | | </br>| apiId | filter | eq | | </br>| operationId | filter | eq | | </br>| callCountSuccess | select, orderBy | | | </br>| callCountBlocked | select, orderBy | | | </br>| callCountFailed | select, orderBy | | | </br>| callCountOther | select, orderBy | | | </br>| callCountTotal | select, orderBy | | | </br>| bandwidth | select, orderBy | | | </br>| cacheHitsCount | select | | | </br>| cacheMissCount | select | | | </br>| apiTimeAvg | select, orderBy | | | </br>| apiTimeMin | select | | | </br>| apiTimeMax | select | | | </br>| serviceTimeAvg | select | | | </br>| serviceTimeMin | select | | | </br>| serviceTimeMax | select | | | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
orderby (str) – OData order by query option.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of ReportRecordContract
- Return type
- Raises
CloudError
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, sid, parameters, notify=None, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
SubscriptionContract or ClientRawResponse if raw=true
- Return type
SubscriptionContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, sid, if_match, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, sid, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
SubscriptionContract or ClientRawResponse if raw=true
- Return type
SubscriptionContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, sid, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list
(resource_group_name, service_name, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| state | filter | eq | | </br>| user | expand | | | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of SubscriptionContract
- Return type
- Raises
-
list_secrets
(resource_group_name, service_name, sid, custom_headers=None, raw=False, **operation_config)[source]¶ Gets the 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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
SubscriptionKeysContract or ClientRawResponse if raw=true
- Return type
SubscriptionKeysContract or ClientRawResponse
- Raises
-
regenerate_primary_key
(resource_group_name, service_name, sid, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
regenerate_secondary_key
(resource_group_name, service_name, sid, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
update
(resource_group_name, service_name, sid, parameters, if_match, notify=None, custom_headers=None, raw=False, **operation_config)[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.
parameters (SubscriptionUpdateParameters) – Update parameters.
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.
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
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
list_by_service
(resource_group_name, service_name, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| aid | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| apiName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| path | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| serviceUrl | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| method | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| urlTemplate | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| state | filter | eq | | </br>| isCurrent | filter | eq | | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of TagResourceContract
- Return type
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
access_name – The identifier of the Access configuration. Constant value: “access”.
-
get
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
AccessInformationContract or ClientRawResponse if raw=true
- Return type
AccessInformationContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
list_secrets
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
AccessInformationContract or ClientRawResponse if raw=true
- Return type
AccessInformationContract or ClientRawResponse
- Raises
-
regenerate_primary_key
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
regenerate_secondary_key
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
update
(resource_group_name, service_name, if_match, enabled=None, custom_headers=None, raw=False, **operation_config)[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.
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.
enabled (bool) – Determines whether direct access is enabled.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
access_name – The identifier of the Access configuration. Constant value: “access”.
-
get
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
AccessInformationContract or ClientRawResponse if raw=true
- Return type
AccessInformationContract or ClientRawResponse
- Raises
-
list_secrets
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
AccessInformationContract or ClientRawResponse if raw=true
- Return type
AccessInformationContract or ClientRawResponse
- Raises
-
regenerate_primary_key
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
regenerate_secondary_key
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
configuration_name – The identifier of the Git Configuration Operation. Constant value: “configuration”.
-
deploy
(resource_group_name, service_name, branch, force=None, custom_headers=None, raw=False, polling=True, **operation_config)[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.
branch (str) – The name of the Git branch from which the configuration is to be deployed to the configuration database.
force (bool) – The value enforcing deleting subscriptions to products that are deleted in this update.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns OperationResultContract or ClientRawResponse<OperationResultContract> if raw==True
- Return type
AzureOperationPoller[OperationResultContract] or AzureOperationPoller[ClientRawResponse[OperationResultContract]]
- Raises
-
get_sync_state
(resource_group_name, service_name, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
TenantConfigurationSyncStateContract or ClientRawResponse if raw=true
- Return type
TenantConfigurationSyncStateContract or ClientRawResponse
- Raises
CloudError
-
save
(resource_group_name, service_name, branch, force=None, custom_headers=None, raw=False, polling=True, **operation_config)[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.
branch (str) – The name of the Git branch in which to commit the current configuration snapshot.
force (bool) – The value if true, the current configuration database is committed to the Git repository, even if the Git repository has newer changes that would be overwritten.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns OperationResultContract or ClientRawResponse<OperationResultContract> if raw==True
- Return type
AzureOperationPoller[OperationResultContract] or AzureOperationPoller[ClientRawResponse[OperationResultContract]]
- Raises
-
validate
(resource_group_name, service_name, branch, force=None, custom_headers=None, raw=False, polling=True, **operation_config)[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.
branch (str) – The name of the Git branch from which the configuration is to be deployed to the configuration database.
force (bool) – The value enforcing deleting subscriptions to products that are deleted in this update.
custom_headers (dict) – headers that will be added to the request
raw (bool) – The poller return type is ClientRawResponse, the direct response alongside the deserialized response
polling – True for ARMPolling, False for no polling, or a polling object for personal polling strategy
- Returns
An instance of LROPoller that returns OperationResultContract or ClientRawResponse<OperationResultContract> if raw==True
- Return type
AzureOperationPoller[OperationResultContract] or AzureOperationPoller[ClientRawResponse[OperationResultContract]]
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
create_or_update
(resource_group_name, service_name, user_id, parameters, if_match=None, custom_headers=None, raw=False, **operation_config)[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.
if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
UserContract or ClientRawResponse if raw=true
- Return type
UserContract or ClientRawResponse
- Raises
-
delete
(resource_group_name, service_name, user_id, if_match, delete_subscriptions=None, notify=None, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
generate_sso_url
(resource_group_name, service_name, user_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
GenerateSsoUrlResult or ClientRawResponse if raw=true
- Return type
GenerateSsoUrlResult or ClientRawResponse
- Raises
-
get
(resource_group_name, service_name, user_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
UserContract or ClientRawResponse if raw=true
- Return type
UserContract or ClientRawResponse
- Raises
-
get_entity_tag
(resource_group_name, service_name, user_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
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.
key_type (str or KeyType) – The Key to be used to generate token for user. Possible values include: ‘primary’, ‘secondary’
expiry (datetime) – The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
UserTokenResult or ClientRawResponse if raw=true
- Return type
UserTokenResult or ClientRawResponse
- Raises
-
list_by_service
(resource_group_name, service_name, filter=None, top=None, skip=None, expand_groups=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| firstName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| lastName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| email | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| state | filter | eq | | </br>| registrationDate | filter | ge, le, eq, ne, gt, lt | | </br>| note | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| groups | expand | | | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
expand_groups (bool) – Detailed Group in response.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of UserContract
- Return type
- Raises
-
update
(resource_group_name, service_name, user_id, parameters, if_match, custom_headers=None, raw=False, **operation_config)[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.
parameters (UserUpdateParameters) – Update parameters.
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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
list
(resource_group_name, service_name, user_id, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of GroupContract
- Return type
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
list
(resource_group_name, service_name, user_id, filter=None, top=None, skip=None, custom_headers=None, raw=False, **operation_config)[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 operatorsSupported functions|</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| stateComment | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| ownerId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| scope | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| userId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>| productId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | </br>
top (int) – Number of records to return.
skip (int) – Number of records to skip.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of SubscriptionContract
- Return type
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
list
(resource_group_name, service_name, user_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
An iterator like instance of UserIdentityContract
- Return type
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
send
(resource_group_name, service_name, user_id, custom_headers=None, raw=False, **operation_config)[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.
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
None or ClientRawResponse if raw=true
- Return type
None or ClientRawResponse
- Raises
-
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 directly this class, but create a Client instance that will create it for you and attach it as attribute.
- Parameters
client – Client for service requests.
config – Configuration of service client.
serializer – An object model serializer.
deserializer – An object model deserializer.
- Variables
export – Query parameter required to export the API details. Constant value: “true”.
api_version – Version of the API to be used with the client request. Constant value: “2019-12-01”.
-
get
(resource_group_name, service_name, api_id, format, custom_headers=None, raw=False, **operation_config)[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. Possible values include: ‘Swagger’, ‘Wsdl’, ‘Wadl’, ‘Openapi’, ‘OpenapiJson’
custom_headers (dict) – headers that will be added to the request
raw (bool) – returns the direct response alongside the deserialized response
operation_config – Operation configuration overrides.
- Returns
ApiExportResult or ClientRawResponse if raw=true
- Return type
ApiExportResult or ClientRawResponse
- Raises
-
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'>¶