azure.mgmt.apimanagement.operations module

class azure.mgmt.apimanagement.operations.ApiDiagnosticOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s api_diagnostic attribute.

create_or_update(resource_group_name: str, service_name: str, api_id: str, diagnostic_id: str, parameters: _models.DiagnosticContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DiagnosticContract

create_or_update(resource_group_name: str, service_name: str, api_id: str, diagnostic_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DiagnosticContract

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance. Required.

• parameters (DiagnosticContract or IO) – Create parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

DiagnosticContract or the result of cls(response)

Return type

DiagnosticContract

Raises

HttpResponseError –

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

Deletes the specified Diagnostic from an API.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, api_id: str, diagnostic_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.DiagnosticContract

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

DiagnosticContract or the result of cls(response)

Return type

DiagnosticContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, diagnostic_id: str, **kwargs: Any) → bool

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. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.DiagnosticContract]

Lists all diagnostics of an API.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  functions |</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DiagnosticContract]

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, api_id: str, diagnostic_id: str, if_match: str, parameters: _models.DiagnosticContract, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DiagnosticContract

update(resource_group_name: str, service_name: str, api_id: str, diagnostic_id: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DiagnosticContract

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

• parameters (DiagnosticContract or IO) – Diagnostic Update parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

DiagnosticContract or the result of cls(response)

Return type

DiagnosticContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ApiExportOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s api_export attribute.

get(resource_group_name: str, service_name: str, api_id: str, format: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.ExportFormat], export: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.ExportApi], **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.ApiExportResult

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. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• format (str or ExportFormat) – Format in which to export the Api Details to the Storage Blob with Sas Key valid for 5 minutes. Known values are: “swagger-link”, “wsdl-link”, “wadl-link”, “openapi-link”, and “openapi+json-link”. Required.

• export (str or ExportApi) – Query parameter required to export the API details. “true” Required.

Keyword Arguments

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

Returns

ApiExportResult or the result of cls(response)

Return type

ApiExportResult

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ApiIssueAttachmentOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s api_issue_attachment attribute.

create_or_update(resource_group_name: str, service_name: str, api_id: str, issue_id: str, attachment_id: str, parameters: _models.IssueAttachmentContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IssueAttachmentContract

create_or_update(resource_group_name: str, service_name: str, api_id: str, issue_id: str, attachment_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IssueAttachmentContract

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. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• issue_id (str) – Issue identifier. Must be unique in the current API Management service instance. Required.

• attachment_id (str) – Attachment identifier within an Issue. Must be unique in the current Issue. Required.

• parameters (IssueAttachmentContract or IO) – Create parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

IssueAttachmentContract or the result of cls(response)

Return type

IssueAttachmentContract

Raises

HttpResponseError –

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

Deletes the specified comment from an Issue.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• issue_id (str) – Issue identifier. Must be unique in the current API Management service instance. Required.

• attachment_id (str) – Attachment identifier within an Issue. Must be unique in the current Issue. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, api_id: str, issue_id: str, attachment_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.IssueAttachmentContract

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. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• issue_id (str) – Issue identifier. Must be unique in the current API Management service instance. Required.

• attachment_id (str) – Attachment identifier within an Issue. Must be unique in the current Issue. Required.

Keyword Arguments

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

Returns

IssueAttachmentContract or the result of cls(response)

Return type

IssueAttachmentContract

Raises

HttpResponseError –

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

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. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• issue_id (str) – Issue identifier. Must be unique in the current API Management service instance. Required.

• attachment_id (str) – Attachment identifier within an Issue. Must be unique in the current Issue. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, api_id: str, issue_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.IssueAttachmentContract]

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• issue_id (str) – Issue identifier. Must be unique in the current API Management service instance. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[IssueAttachmentContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ApiIssueCommentOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s api_issue_comment attribute.

create_or_update(resource_group_name: str, service_name: str, api_id: str, issue_id: str, comment_id: str, parameters: _models.IssueCommentContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IssueCommentContract

create_or_update(resource_group_name: str, service_name: str, api_id: str, issue_id: str, comment_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IssueCommentContract

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. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• issue_id (str) – Issue identifier. Must be unique in the current API Management service instance. Required.

• comment_id (str) – Comment identifier within an Issue. Must be unique in the current Issue. Required.

• parameters (IssueCommentContract or IO) – Create parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

IssueCommentContract or the result of cls(response)

Return type

IssueCommentContract

Raises

HttpResponseError –

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

Deletes the specified comment from an Issue.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• issue_id (str) – Issue identifier. Must be unique in the current API Management service instance. Required.

• comment_id (str) – Comment identifier within an Issue. Must be unique in the current Issue. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, api_id: str, issue_id: str, comment_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.IssueCommentContract

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. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• issue_id (str) – Issue identifier. Must be unique in the current API Management service instance. Required.

• comment_id (str) – Comment identifier within an Issue. Must be unique in the current Issue. Required.

Keyword Arguments

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

Returns

IssueCommentContract or the result of cls(response)

Return type

IssueCommentContract

Raises

HttpResponseError –

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

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. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• issue_id (str) – Issue identifier. Must be unique in the current API Management service instance. Required.

• comment_id (str) – Comment identifier within an Issue. Must be unique in the current Issue. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, api_id: str, issue_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.IssueCommentContract]

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• issue_id (str) – Issue identifier. Must be unique in the current API Management service instance. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[IssueCommentContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ApiIssueOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s api_issue attribute.

create_or_update(resource_group_name: str, service_name: str, api_id: str, issue_id: str, parameters: _models.IssueContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IssueContract

create_or_update(resource_group_name: str, service_name: str, api_id: str, issue_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IssueContract

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• issue_id (str) – Issue identifier. Must be unique in the current API Management service instance. Required.

• parameters (IssueContract or IO) – Create parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

IssueContract or the result of cls(response)

Return type

IssueContract

Raises

HttpResponseError –

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

Deletes the specified Issue from an API.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• issue_id (str) – Issue identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, api_id: str, issue_id: str, expand_comments_attachments: Optional[bool] = None, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.IssueContract

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• issue_id (str) – Issue identifier. Must be unique in the current API Management service instance. Required.

• expand_comments_attachments (bool) – Expand the comment attachments. Default value is None.

Keyword Arguments

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

Returns

IssueContract or the result of cls(response)

Return type

IssueContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, issue_id: str, **kwargs: Any) → bool

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. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• issue_id (str) – Issue identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, expand_comments_attachments: Optional[bool] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.IssueContract]

Lists all issues associated with the specified API.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• expand_comments_attachments (bool) – Expand the comment attachments. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[IssueContract]

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, api_id: str, issue_id: str, if_match: str, parameters: _models.IssueUpdateContract, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IssueContract

update(resource_group_name: str, service_name: str, api_id: str, issue_id: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IssueContract

Updates an existing issue for an API.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• issue_id (str) – Issue identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

• parameters (IssueUpdateContract or IO) – Update parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

IssueContract or the result of cls(response)

Return type

IssueContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ApiManagementClientOperationsMixin

Bases: azure.mgmt.apimanagement._vendor.ApiManagementClientMixinABC

begin_perform_connectivity_check_async(resource_group_name: str, service_name: str, connectivity_check_request_params: _models.ConnectivityCheckRequest, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ConnectivityCheckResponse]

begin_perform_connectivity_check_async(resource_group_name: str, service_name: str, connectivity_check_request_params: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ConnectivityCheckResponse]

Performs a connectivity check between the API Management service and a given destination, and returns metrics for the connection, as well as errors encountered while trying to establish it.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• connectivity_check_request_params (ConnectivityCheckRequest or IO) – Connectivity Check request parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ConnectivityCheckResponse]

Raises

HttpResponseError –

class azure.mgmt.apimanagement.operations.ApiManagementOperationsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s api_management_operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.Operation]

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[Operation]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ApiManagementServiceOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s api_management_service attribute.

begin_apply_network_configuration_updates(resource_group_name: str, service_name: str, parameters: Optional[_models.ApiManagementServiceApplyNetworkConfigurationParameters] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApiManagementServiceResource]

begin_apply_network_configuration_updates(resource_group_name: str, service_name: str, parameters: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApiManagementServiceResource]

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• parameters (ApiManagementServiceApplyNetworkConfigurationParameters or IO) – Parameters supplied to the Apply Network Configuration operation. If the parameters are empty, all the regions in which the Api Management service is deployed will be updated sequentially without incurring downtime in the region. Is either a model type or a IO type. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ApiManagementServiceResource]

Raises

HttpResponseError –

begin_backup(resource_group_name: str, service_name: str, parameters: _models.ApiManagementServiceBackupRestoreParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApiManagementServiceResource]

begin_backup(resource_group_name: str, service_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApiManagementServiceResource]

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. Required.

• service_name (str) – The name of the API Management service. Required.

• parameters (ApiManagementServiceBackupRestoreParameters or IO) – Parameters supplied to the ApiManagementService_Backup operation. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ApiManagementServiceResource]

Raises

HttpResponseError –

begin_create_or_update(resource_group_name: str, service_name: str, parameters: _models.ApiManagementServiceResource, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApiManagementServiceResource]

begin_create_or_update(resource_group_name: str, service_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApiManagementServiceResource]

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. Required.

• service_name (str) – The name of the API Management service. Required.

• parameters (ApiManagementServiceResource or IO) – Parameters supplied to the CreateOrUpdate API Management service operation. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ApiManagementServiceResource]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, service_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Deletes an existing API Management service.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ApiManagementServiceResource]

Raises

HttpResponseError –

begin_restore(resource_group_name: str, service_name: str, parameters: _models.ApiManagementServiceBackupRestoreParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApiManagementServiceResource]

begin_restore(resource_group_name: str, service_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApiManagementServiceResource]

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. Required.

• service_name (str) – The name of the API Management service. Required.

• parameters (ApiManagementServiceBackupRestoreParameters or IO) – Parameters supplied to the Restore API Management service from backup operation. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ApiManagementServiceResource]

Raises

HttpResponseError –

begin_update(resource_group_name: str, service_name: str, parameters: _models.ApiManagementServiceUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApiManagementServiceResource]

begin_update(resource_group_name: str, service_name: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApiManagementServiceResource]

Updates an existing API Management service.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• parameters (ApiManagementServiceUpdateParameters or IO) – Parameters supplied to the CreateOrUpdate API Management service operation. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ApiManagementServiceResource]

Raises

HttpResponseError –

check_name_availability(parameters: _models.ApiManagementServiceCheckNameAvailabilityParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ApiManagementServiceNameAvailabilityResult

check_name_availability(parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ApiManagementServiceNameAvailabilityResult

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

Parameters

parameters (ApiManagementServiceCheckNameAvailabilityParameters or IO) – Parameters supplied to the CheckNameAvailability operation. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

ApiManagementServiceNameAvailabilityResult or the result of cls(response)

Return type

ApiManagementServiceNameAvailabilityResult

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.ApiManagementServiceResource

Gets an API Management service resource description.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

Returns

ApiManagementServiceResource or the result of cls(response)

Return type

ApiManagementServiceResource

Raises

HttpResponseError –

get_domain_ownership_identifier(**kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.ApiManagementServiceGetDomainOwnershipIdentifierResult

Get the custom domain ownership identifier for an API Management service.

Keyword Arguments

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

Returns

ApiManagementServiceGetDomainOwnershipIdentifierResult or the result of cls(response)

Return type

ApiManagementServiceGetDomainOwnershipIdentifierResult

Raises

HttpResponseError –

get_sso_token(resource_group_name: str, service_name: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.ApiManagementServiceGetSsoTokenResult

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. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

Returns

ApiManagementServiceGetSsoTokenResult or the result of cls(response)

Return type

ApiManagementServiceGetSsoTokenResult

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ApiManagementServiceResource]

Lists all API Management services within an Azure subscription.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ApiManagementServiceResource]

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ApiManagementServiceResource]

List all API Management services within a resource group.

Parameters

resource_group_name (str) – The name of the resource group. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ApiManagementServiceResource]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ApiManagementServiceSkusOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s api_management_service_skus attribute.

list_available_service_skus(resource_group_name: str, service_name: str, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ResourceSkuResult]

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. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ResourceSkuResult]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ApiManagementSkusOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s api_management_skus attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ApiManagementSku]

Gets the list of Microsoft.ApiManagement SKUs available for your Subscription.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ApiManagementSku]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ApiOperationOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s api_operation attribute.

create_or_update(resource_group_name: str, service_name: str, api_id: str, operation_id: str, parameters: _models.OperationContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.OperationContract

create_or_update(resource_group_name: str, service_name: str, api_id: str, operation_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.OperationContract

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance. Required.

• parameters (OperationContract or IO) – Create parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

OperationContract or the result of cls(response)

Return type

OperationContract

Raises

HttpResponseError –

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

Deletes the specified operation in the API.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, api_id: str, operation_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.OperationContract

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

OperationContract or the result of cls(response)

Return type

OperationContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, operation_id: str, **kwargs: Any) → bool

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. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_api(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, tags: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.OperationContract]

Lists a collection of the operations for the specified API.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

• tags (str) – Include tags in the response. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[OperationContract]

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, api_id: str, operation_id: str, if_match: str, parameters: _models.OperationUpdateContract, *, content_type: str = "'application/json'", **kwargs: Any) → _models.OperationContract

update(resource_group_name: str, service_name: str, api_id: str, operation_id: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.OperationContract

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance. Required.

• 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. Required.

• parameters (OperationUpdateContract or IO) – API Operation Update parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

OperationContract or the result of cls(response)

Return type

OperationContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ApiOperationPolicyOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s api_operation_policy attribute.

create_or_update(resource_group_name: str, service_name: str, api_id: str, operation_id: str, policy_id: Union[str, _models.PolicyIdName], parameters: _models.PolicyContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PolicyContract

create_or_update(resource_group_name: str, service_name: str, api_id: str, operation_id: str, policy_id: Union[str, _models.PolicyIdName], parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PolicyContract

Creates or updates policy configuration for the API Operation level.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance. Required.

• policy_id (str or PolicyIdName) – The identifier of the Policy. “policy” Required.

• parameters (PolicyContract or IO) – The policy contents to apply. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

PolicyContract or the result of cls(response)

Return type

PolicyContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, api_id: str, operation_id: str, policy_id: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.PolicyIdName], if_match: str, **kwargs: Any) → None

Deletes the policy configuration at the Api Operation.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance. Required.

• policy_id (str or PolicyIdName) – The identifier of the Policy. “policy” Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, api_id: str, operation_id: str, policy_id: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.PolicyIdName], format: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.PolicyExportFormat] = 'xml', **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.PolicyContract

Get the policy configuration at the API Operation level.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance. Required.

• policy_id (str or PolicyIdName) – The identifier of the Policy. “policy” Required.

• format (str or PolicyExportFormat) – Policy Export Format. Known values are: “xml” and “rawxml”. Default value is “xml”.

Keyword Arguments

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

Returns

PolicyContract or the result of cls(response)

Return type

PolicyContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, operation_id: str, policy_id: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.PolicyIdName], **kwargs: Any) → bool

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. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance. Required.

• policy_id (str or PolicyIdName) – The identifier of the Policy. “policy” Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_operation(resource_group_name: str, service_name: str, api_id: str, operation_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.PolicyCollection

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

PolicyCollection or the result of cls(response)

Return type

PolicyCollection

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ApiOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s api attribute.

begin_create_or_update(resource_group_name: str, service_name: str, api_id: str, parameters: _models.ApiCreateOrUpdateParameter, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApiContract]

begin_create_or_update(resource_group_name: str, service_name: str, api_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.ApiContract]

Creates new or updates existing specified API of the API Management service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• parameters (ApiCreateOrUpdateParameter or IO) – Create or update parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[ApiContract]

Raises

HttpResponseError –

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

Deletes the specified API of the API Management service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• 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. Required.

• delete_revisions (bool) – Delete all revisions of the Api. Default value is None.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, api_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.ApiContract

Gets the details of the API specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

Keyword Arguments

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

Returns

ApiContract or the result of cls(response)

Return type

ApiContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, tags: Optional[str] = None, expand_api_version_set: Optional[bool] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ApiContract]

Lists all APIs of the API Management service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>| isCurrent | filter | eq, ne | |</br>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

• tags (str) – Include tags in the response. Default value is None.

• expand_api_version_set (bool) – Include full ApiVersionSet resource in response. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ApiContract]

Raises

HttpResponseError –

list_by_tags(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, include_not_tagged_apis: Optional[bool] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.TagResourceContract]

Lists a collection of apis associated with tags.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>| 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>| isCurrent | filter | eq | |</br>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

• include_not_tagged_apis (bool) – Include not tagged APIs. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[TagResourceContract]

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, api_id: str, if_match: str, parameters: _models.ApiUpdateContract, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ApiContract

update(resource_group_name: str, service_name: str, api_id: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ApiContract

Updates the specified API of the API Management service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• 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. Required.

• parameters (ApiUpdateContract or IO) – API Update Contract parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

ApiContract or the result of cls(response)

Return type

ApiContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ApiPolicyOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s api_policy attribute.

create_or_update(resource_group_name: str, service_name: str, api_id: str, policy_id: Union[str, _models.PolicyIdName], parameters: _models.PolicyContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PolicyContract

create_or_update(resource_group_name: str, service_name: str, api_id: str, policy_id: Union[str, _models.PolicyIdName], parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PolicyContract

Creates or updates policy configuration for the API.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• policy_id (str or PolicyIdName) – The identifier of the Policy. “policy” Required.

• parameters (PolicyContract or IO) – The policy contents to apply. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

PolicyContract or the result of cls(response)

Return type

PolicyContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, api_id: str, policy_id: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.PolicyIdName], if_match: str, **kwargs: Any) → None

Deletes the policy configuration at the Api.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• policy_id (str or PolicyIdName) – The identifier of the Policy. “policy” Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, api_id: str, policy_id: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.PolicyIdName], format: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.PolicyExportFormat] = 'xml', **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.PolicyContract

Get the policy configuration at the API level.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• policy_id (str or PolicyIdName) – The identifier of the Policy. “policy” Required.

• format (str or PolicyExportFormat) – Policy Export Format. Known values are: “xml” and “rawxml”. Default value is “xml”.

Keyword Arguments

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

Returns

PolicyContract or the result of cls(response)

Return type

PolicyContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, policy_id: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.PolicyIdName], **kwargs: Any) → bool

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. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• policy_id (str or PolicyIdName) – The identifier of the Policy. “policy” Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_api(resource_group_name: str, service_name: str, api_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.PolicyCollection

Get the policy configuration at the API level.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

Keyword Arguments

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

Returns

PolicyCollection or the result of cls(response)

Return type

PolicyCollection

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ApiProductOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s api_product attribute.

list_by_apis(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ProductContract]

Lists all Products, which the API is part of.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  functions |</br>|————-|-------------|————-|-------------|</br>| displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ProductContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ApiReleaseOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s api_release attribute.

create_or_update(resource_group_name: str, service_name: str, api_id: str, release_id: str, parameters: _models.ApiReleaseContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ApiReleaseContract

create_or_update(resource_group_name: str, service_name: str, api_id: str, release_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ApiReleaseContract

Creates a new Release for the API.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• release_id (str) – Release identifier within an API. Must be unique in the current API Management service instance. Required.

• parameters (ApiReleaseContract or IO) – Create parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

ApiReleaseContract or the result of cls(response)

Return type

ApiReleaseContract

Raises

HttpResponseError –

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

Deletes the specified release in the API.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• release_id (str) – Release identifier within an API. Must be unique in the current API Management service instance. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, api_id: str, release_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.ApiReleaseContract

Returns the details of an API release.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• release_id (str) – Release identifier within an API. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

ApiReleaseContract or the result of cls(response)

Return type

ApiReleaseContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, release_id: str, **kwargs: Any) → bool

Returns the etag of an API release.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• release_id (str) – Release identifier within an API. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ApiReleaseContract]

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. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  functions |</br>|————-|-------------|————-|-------------|</br>| notes | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ApiReleaseContract]

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, api_id: str, release_id: str, if_match: str, parameters: _models.ApiReleaseContract, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ApiReleaseContract

update(resource_group_name: str, service_name: str, api_id: str, release_id: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ApiReleaseContract

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• release_id (str) – Release identifier within an API. Must be unique in the current API Management service instance. Required.

• 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. Required.

• parameters (ApiReleaseContract or IO) – API Release Update parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

ApiReleaseContract or the result of cls(response)

Return type

ApiReleaseContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ApiRevisionOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s api_revision attribute.

list_by_service(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ApiRevisionContract]

Lists all revisions of an API.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  functions |</br>|————-|-------------|————-|-------------|</br>| apiRevision | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ApiRevisionContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ApiSchemaOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s api_schema attribute.

begin_create_or_update(resource_group_name: str, service_name: str, api_id: str, schema_id: str, parameters: _models.SchemaContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SchemaContract]

begin_create_or_update(resource_group_name: str, service_name: str, api_id: str, schema_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SchemaContract]

Creates or updates schema configuration for the API.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• schema_id (str) – Schema id identifier. Must be unique in the current API Management service instance. Required.

• parameters (SchemaContract or IO) – The schema contents to apply. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[SchemaContract]

Raises

HttpResponseError –

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

Deletes the schema configuration at the Api.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• schema_id (str) – Schema id identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

• force (bool) – If true removes all references to the schema before deleting it. Default value is None.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, api_id: str, schema_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.SchemaContract

Get the schema configuration at the API level.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• schema_id (str) – Schema id identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

SchemaContract or the result of cls(response)

Return type

SchemaContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, schema_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• schema_id (str) – Schema id identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_api(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.SchemaContract]

Get the schema configuration at the API level.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  functions |</br>|————-|-------------|————-|-------------|</br>| contentType | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SchemaContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ApiTagDescriptionOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s api_tag_description attribute.

create_or_update(resource_group_name: str, service_name: str, api_id: str, tag_description_id: str, parameters: _models.TagDescriptionCreateParameters, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TagDescriptionContract

create_or_update(resource_group_name: str, service_name: str, api_id: str, tag_description_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TagDescriptionContract

Create/Update tag description in scope of the Api.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• tag_description_id (str) – Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names. Required.

• parameters (TagDescriptionCreateParameters or IO) – Create parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

TagDescriptionContract or the result of cls(response)

Return type

TagDescriptionContract

Raises

HttpResponseError –

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

Delete tag description for the Api.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• tag_description_id (str) – Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, api_id: str, tag_description_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.TagDescriptionContract

Get Tag description in scope of API.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• tag_description_id (str) – Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names. Required.

Keyword Arguments

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

Returns

TagDescriptionContract or the result of cls(response)

Return type

TagDescriptionContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, api_id: str, tag_description_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• tag_description_id (str) – Tag description identifier. Used when creating tagDescription for API/Tag association. Based on API and Tag names. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.TagDescriptionContract]

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. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[TagDescriptionContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ApiVersionSetOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s api_version_set attribute.

create_or_update(resource_group_name: str, service_name: str, version_set_id: str, parameters: _models.ApiVersionSetContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ApiVersionSetContract

create_or_update(resource_group_name: str, service_name: str, version_set_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ApiVersionSetContract

Creates or Updates a Api Version Set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• version_set_id (str) – Api Version Set identifier. Must be unique in the current API Management service instance. Required.

• parameters (ApiVersionSetContract or IO) – Create or update parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

ApiVersionSetContract or the result of cls(response)

Return type

ApiVersionSetContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, version_set_id: str, if_match: str, **kwargs: Any) → None

Deletes specific Api Version Set.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• version_set_id (str) – Api Version Set identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, version_set_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.ApiVersionSetContract

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• version_set_id (str) – Api Version Set identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

ApiVersionSetContract or the result of cls(response)

Return type

ApiVersionSetContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, version_set_id: str, **kwargs: Any) → bool

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. Required.

• service_name (str) – The name of the API Management service. Required.

• version_set_id (str) – Api Version Set identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ApiVersionSetContract]

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  functions |</br>|————-|-------------|————-|————-|</br>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ApiVersionSetContract]

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, version_set_id: str, if_match: str, parameters: _models.ApiVersionSetUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ApiVersionSetContract

update(resource_group_name: str, service_name: str, version_set_id: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ApiVersionSetContract

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• version_set_id (str) – Api Version Set identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

• parameters (ApiVersionSetUpdateParameters or IO) – Update parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

ApiVersionSetContract or the result of cls(response)

Return type

ApiVersionSetContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.AuthorizationServerOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s authorization_server attribute.

create_or_update(resource_group_name: str, service_name: str, authsid: str, parameters: _models.AuthorizationServerContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AuthorizationServerContract

create_or_update(resource_group_name: str, service_name: str, authsid: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AuthorizationServerContract

Creates new authorization server or updates an existing authorization server.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• authsid (str) – Identifier of the authorization server. Required.

• parameters (AuthorizationServerContract or IO) – Create or update parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

AuthorizationServerContract or the result of cls(response)

Return type

AuthorizationServerContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, authsid: str, if_match: str, **kwargs: Any) → None

Deletes specific authorization server instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• authsid (str) – Identifier of the authorization server. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, authsid: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.AuthorizationServerContract

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• authsid (str) – Identifier of the authorization server. Required.

Keyword Arguments

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

Returns

AuthorizationServerContract or the result of cls(response)

Return type

AuthorizationServerContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, authsid: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• authsid (str) – Identifier of the authorization server. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.AuthorizationServerContract]

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[AuthorizationServerContract]

Raises

HttpResponseError –

list_secrets(resource_group_name: str, service_name: str, authsid: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.AuthorizationServerSecretsContract

Gets the client secret details of the authorization server.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• authsid (str) – Identifier of the authorization server. Required.

Keyword Arguments

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

Returns

AuthorizationServerSecretsContract or the result of cls(response)

Return type

AuthorizationServerSecretsContract

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, authsid: str, if_match: str, parameters: _models.AuthorizationServerUpdateContract, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AuthorizationServerContract

update(resource_group_name: str, service_name: str, authsid: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AuthorizationServerContract

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• authsid (str) – Identifier of the authorization server. Required.

• 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. Required.

• parameters (AuthorizationServerUpdateContract or IO) – OAuth2 Server settings Update parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

AuthorizationServerContract or the result of cls(response)

Return type

AuthorizationServerContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.BackendOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s backend attribute.

create_or_update(resource_group_name: str, service_name: str, backend_id: str, parameters: _models.BackendContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.BackendContract

create_or_update(resource_group_name: str, service_name: str, backend_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.BackendContract

Creates or Updates a backend.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• backend_id (str) – Identifier of the Backend entity. Must be unique in the current API Management service instance. Required.

• parameters (BackendContract or IO) – Create parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

BackendContract or the result of cls(response)

Return type

BackendContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, backend_id: str, if_match: str, **kwargs: Any) → None

Deletes the specified backend.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• backend_id (str) – Identifier of the Backend entity. Must be unique in the current API Management service instance. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, backend_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.BackendContract

Gets the details of the backend specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• backend_id (str) – Identifier of the Backend entity. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

BackendContract or the result of cls(response)

Return type

BackendContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, backend_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• backend_id (str) – Identifier of the Backend entity. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.BackendContract]

Lists a collection of backends in the specified service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[BackendContract]

Raises

HttpResponseError –

reconnect(resource_group_name: str, service_name: str, backend_id: str, parameters: Optional[_models.BackendReconnectContract] = None, *, content_type: str = "'application/json'", **kwargs: Any) → None

reconnect(resource_group_name: str, service_name: str, backend_id: str, parameters: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → None

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. Required.

• service_name (str) – The name of the API Management service. Required.

• backend_id (str) – Identifier of the Backend entity. Must be unique in the current API Management service instance. Required.

• parameters (BackendReconnectContract or IO) – Reconnect request parameters. Is either a model type or a IO type. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, backend_id: str, if_match: str, parameters: _models.BackendUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.BackendContract

update(resource_group_name: str, service_name: str, backend_id: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.BackendContract

Updates an existing backend.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• backend_id (str) – Identifier of the Backend entity. Must be unique in the current API Management service instance. Required.

• 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. Required.

• parameters (BackendUpdateParameters or IO) – Update parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

BackendContract or the result of cls(response)

Return type

BackendContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.CacheOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s cache attribute.

create_or_update(resource_group_name: str, service_name: str, cache_id: str, parameters: _models.CacheContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CacheContract

create_or_update(resource_group_name: str, service_name: str, cache_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CacheContract

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• cache_id (str) – Identifier of the Cache entity. Cache identifier (should be either ‘default’ or valid Azure region identifier). Required.

• parameters (CacheContract or IO) – Create or Update parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

CacheContract or the result of cls(response)

Return type

CacheContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, cache_id: str, if_match: str, **kwargs: Any) → None

Deletes specific Cache.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• cache_id (str) – Identifier of the Cache entity. Cache identifier (should be either ‘default’ or valid Azure region identifier). Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, cache_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.CacheContract

Gets the details of the Cache specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• cache_id (str) – Identifier of the Cache entity. Cache identifier (should be either ‘default’ or valid Azure region identifier). Required.

Keyword Arguments

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

Returns

CacheContract or the result of cls(response)

Return type

CacheContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, cache_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• cache_id (str) – Identifier of the Cache entity. Cache identifier (should be either ‘default’ or valid Azure region identifier). Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.CacheContract]

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[CacheContract]

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, cache_id: str, if_match: str, parameters: _models.CacheUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CacheContract

update(resource_group_name: str, service_name: str, cache_id: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CacheContract

Updates the details of the cache specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• cache_id (str) – Identifier of the Cache entity. Cache identifier (should be either ‘default’ or valid Azure region identifier). Required.

• 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. Required.

• parameters (CacheUpdateParameters or IO) – Update parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

CacheContract or the result of cls(response)

Return type

CacheContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.CertificateOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s certificate attribute.

create_or_update(resource_group_name: str, service_name: str, certificate_id: str, parameters: _models.CertificateCreateOrUpdateParameters, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CertificateContract

create_or_update(resource_group_name: str, service_name: str, certificate_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CertificateContract

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• certificate_id (str) – Identifier of the certificate entity. Must be unique in the current API Management service instance. Required.

• parameters (CertificateCreateOrUpdateParameters or IO) – Create or Update parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

CertificateContract or the result of cls(response)

Return type

CertificateContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, certificate_id: str, if_match: str, **kwargs: Any) → None

Deletes specific certificate.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• certificate_id (str) – Identifier of the certificate entity. Must be unique in the current API Management service instance. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, certificate_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.CertificateContract

Gets the details of the certificate specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• certificate_id (str) – Identifier of the certificate entity. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

CertificateContract or the result of cls(response)

Return type

CertificateContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, certificate_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• certificate_id (str) – Identifier of the certificate entity. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, is_key_vault_refresh_failed: Optional[bool] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.CertificateContract]

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

• is_key_vault_refresh_failed (bool) – When set to true, the response contains only certificates entities which failed refresh. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[CertificateContract]

Raises

HttpResponseError –

refresh_secret(resource_group_name: str, service_name: str, certificate_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.CertificateContract

From KeyVault, Refresh the certificate being used for authentication with the backend.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• certificate_id (str) – Identifier of the certificate entity. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

CertificateContract or the result of cls(response)

Return type

CertificateContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ContentItemOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s content_item attribute.

create_or_update(resource_group_name: str, service_name: str, content_type_id: str, content_item_id: str, if_match: Optional[str] = None, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.ContentItemContract

Creates a new developer portal’s content item specified by the provided content type.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• content_type_id (str) – Content type identifier. Required.

• content_item_id (str) – Content item identifier. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

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

Returns

ContentItemContract or the result of cls(response)

Return type

ContentItemContract

Raises

HttpResponseError –

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

Removes the specified developer portal’s content item.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• content_type_id (str) – Content type identifier. Required.

• content_item_id (str) – Content item identifier. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, content_type_id: str, content_item_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.ContentItemContract

Returns the developer portal’s content item specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• content_type_id (str) – Content type identifier. Required.

• content_item_id (str) – Content item identifier. Required.

Keyword Arguments

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

Returns

ContentItemContract or the result of cls(response)

Return type

ContentItemContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, content_type_id: str, content_item_id: str, **kwargs: Any) → bool

Returns the entity state (ETag) version of the developer portal’s content item specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• content_type_id (str) – Content type identifier. Required.

• content_item_id (str) – Content item identifier. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, content_type_id: str, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ContentItemContract]

Lists developer portal’s content items specified by the provided content type.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• content_type_id (str) – Content type identifier. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ContentItemContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ContentTypeOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s content_type attribute.

create_or_update(resource_group_name: str, service_name: str, content_type_id: str, if_match: Optional[str] = None, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.ContentTypeContract

Creates or updates the developer portal’s content type. Content types describe content items’ properties, validation rules, and constraints. Custom content types’ identifiers need to start with the c- prefix. Built-in content types can’t be modified.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• content_type_id (str) – Content type identifier. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

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

Returns

ContentTypeContract or the result of cls(response)

Return type

ContentTypeContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, content_type_id: str, if_match: str, **kwargs: Any) → None

Removes the specified developer portal’s content type. Content types describe content items’ properties, validation rules, and constraints. Built-in content types (with identifiers starting with the c- prefix) can’t be removed.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• content_type_id (str) – Content type identifier. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, content_type_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.ContentTypeContract

Gets the details of the developer portal’s content type. Content types describe content items’ properties, validation rules, and constraints.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• content_type_id (str) – Content type identifier. Required.

Keyword Arguments

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

Returns

ContentTypeContract or the result of cls(response)

Return type

ContentTypeContract

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ContentTypeContract]

Lists the developer portal’s content types. Content types describe content items’ properties, validation rules, and constraints.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ContentTypeContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.DelegationSettingsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s delegation_settings attribute.

create_or_update(resource_group_name: str, service_name: str, parameters: _models.PortalDelegationSettings, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PortalDelegationSettings

create_or_update(resource_group_name: str, service_name: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PortalDelegationSettings

Create or Update Delegation settings.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• parameters (PortalDelegationSettings or IO) – Create or update parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

PortalDelegationSettings or the result of cls(response)

Return type

PortalDelegationSettings

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.PortalDelegationSettings

Get Delegation Settings for the Portal.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

Returns

PortalDelegationSettings or the result of cls(response)

Return type

PortalDelegationSettings

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, **kwargs: Any) → bool

Gets the entity state (Etag) version of the DelegationSettings.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_secrets(resource_group_name: str, service_name: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.PortalSettingValidationKeyContract

Gets the secret validation key of the DelegationSettings.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

Returns

PortalSettingValidationKeyContract or the result of cls(response)

Return type

PortalSettingValidationKeyContract

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, if_match: str, parameters: _models.PortalDelegationSettings, *, content_type: str = "'application/json'", **kwargs: Any) → None

update(resource_group_name: str, service_name: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → None

Update Delegation settings.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• parameters (PortalDelegationSettings or IO) – Update Delegation settings. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.DeletedServicesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s deleted_services attribute.

begin_purge(service_name: str, location: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

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

Parameters

• service_name (str) – The name of the API Management service. Required.

• location (str) – The location of the deleted API Management service. Required.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[DeletedServiceContract]

Raises

HttpResponseError –

get_by_name(service_name: str, location: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.DeletedServiceContract

Get soft-deleted Api Management Service by name.

Parameters

• service_name (str) – The name of the API Management service. Required.

• location (str) – The location of the deleted API Management service. Required.

Keyword Arguments

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

Returns

DeletedServiceContract or the result of cls(response)

Return type

DeletedServiceContract

Raises

HttpResponseError –

list_by_subscription(**kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.DeletedServiceContract]

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

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DeletedServiceContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.DiagnosticOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s diagnostic attribute.

create_or_update(resource_group_name: str, service_name: str, diagnostic_id: str, parameters: _models.DiagnosticContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DiagnosticContract

create_or_update(resource_group_name: str, service_name: str, diagnostic_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DiagnosticContract

Creates a new Diagnostic or updates an existing one.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance. Required.

• parameters (DiagnosticContract or IO) – Create parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

DiagnosticContract or the result of cls(response)

Return type

DiagnosticContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, diagnostic_id: str, if_match: str, **kwargs: Any) → None

Deletes the specified Diagnostic.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, diagnostic_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.DiagnosticContract

Gets the details of the Diagnostic specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

DiagnosticContract or the result of cls(response)

Return type

DiagnosticContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, diagnostic_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.DiagnosticContract]

Lists all diagnostics of the API Management service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  functions |</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[DiagnosticContract]

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, diagnostic_id: str, if_match: str, parameters: _models.DiagnosticContract, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DiagnosticContract

update(resource_group_name: str, service_name: str, diagnostic_id: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.DiagnosticContract

Updates the details of the Diagnostic specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• diagnostic_id (str) – Diagnostic identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

• parameters (DiagnosticContract or IO) – Diagnostic Update parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

DiagnosticContract or the result of cls(response)

Return type

DiagnosticContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.EmailTemplateOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s email_template attribute.

create_or_update(resource_group_name: str, service_name: str, template_name: Union[str, _models.TemplateName], parameters: _models.EmailTemplateUpdateParameters, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.EmailTemplateContract

create_or_update(resource_group_name: str, service_name: str, template_name: Union[str, _models.TemplateName], parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.EmailTemplateContract

Updates an Email Template.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• template_name (str or TemplateName) – Email Template Name Identifier. Known values are: “applicationApprovedNotificationMessage”, “accountClosedDeveloper”, “quotaLimitApproachingDeveloperNotificationMessage”, “newDeveloperNotificationMessage”, “emailChangeIdentityDefault”, “inviteUserNotificationMessage”, “newCommentNotificationMessage”, “confirmSignUpIdentityDefault”, “newIssueNotificationMessage”, “purchaseDeveloperNotificationMessage”, “passwordResetIdentityDefault”, “passwordResetByAdminNotificationMessage”, “rejectDeveloperNotificationMessage”, and “requestDeveloperNotificationMessage”. Required.

• parameters (EmailTemplateUpdateParameters or IO) – Email Template update parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

EmailTemplateContract or the result of cls(response)

Return type

EmailTemplateContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, template_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.TemplateName], if_match: str, **kwargs: Any) → None

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. Required.

• service_name (str) – The name of the API Management service. Required.

• template_name (str or TemplateName) – Email Template Name Identifier. Known values are: “applicationApprovedNotificationMessage”, “accountClosedDeveloper”, “quotaLimitApproachingDeveloperNotificationMessage”, “newDeveloperNotificationMessage”, “emailChangeIdentityDefault”, “inviteUserNotificationMessage”, “newCommentNotificationMessage”, “confirmSignUpIdentityDefault”, “newIssueNotificationMessage”, “purchaseDeveloperNotificationMessage”, “passwordResetIdentityDefault”, “passwordResetByAdminNotificationMessage”, “rejectDeveloperNotificationMessage”, and “requestDeveloperNotificationMessage”. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, template_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.TemplateName], **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.EmailTemplateContract

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• template_name (str or TemplateName) – Email Template Name Identifier. Known values are: “applicationApprovedNotificationMessage”, “accountClosedDeveloper”, “quotaLimitApproachingDeveloperNotificationMessage”, “newDeveloperNotificationMessage”, “emailChangeIdentityDefault”, “inviteUserNotificationMessage”, “newCommentNotificationMessage”, “confirmSignUpIdentityDefault”, “newIssueNotificationMessage”, “purchaseDeveloperNotificationMessage”, “passwordResetIdentityDefault”, “passwordResetByAdminNotificationMessage”, “rejectDeveloperNotificationMessage”, and “requestDeveloperNotificationMessage”. Required.

Keyword Arguments

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

Returns

EmailTemplateContract or the result of cls(response)

Return type

EmailTemplateContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, template_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.TemplateName], **kwargs: Any) → bool

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. Required.

• service_name (str) – The name of the API Management service. Required.

• template_name (str or TemplateName) – Email Template Name Identifier. Known values are: “applicationApprovedNotificationMessage”, “accountClosedDeveloper”, “quotaLimitApproachingDeveloperNotificationMessage”, “newDeveloperNotificationMessage”, “emailChangeIdentityDefault”, “inviteUserNotificationMessage”, “newCommentNotificationMessage”, “confirmSignUpIdentityDefault”, “newIssueNotificationMessage”, “purchaseDeveloperNotificationMessage”, “passwordResetIdentityDefault”, “passwordResetByAdminNotificationMessage”, “rejectDeveloperNotificationMessage”, and “requestDeveloperNotificationMessage”. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.EmailTemplateContract]

Gets all email templates.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  functions |</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[EmailTemplateContract]

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, template_name: Union[str, _models.TemplateName], if_match: str, parameters: _models.EmailTemplateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.EmailTemplateContract

update(resource_group_name: str, service_name: str, template_name: Union[str, _models.TemplateName], if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.EmailTemplateContract

Updates API Management email template.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• template_name (str or TemplateName) – Email Template Name Identifier. Known values are: “applicationApprovedNotificationMessage”, “accountClosedDeveloper”, “quotaLimitApproachingDeveloperNotificationMessage”, “newDeveloperNotificationMessage”, “emailChangeIdentityDefault”, “inviteUserNotificationMessage”, “newCommentNotificationMessage”, “confirmSignUpIdentityDefault”, “newIssueNotificationMessage”, “purchaseDeveloperNotificationMessage”, “passwordResetIdentityDefault”, “passwordResetByAdminNotificationMessage”, “rejectDeveloperNotificationMessage”, and “requestDeveloperNotificationMessage”. Required.

• 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. Required.

• parameters (EmailTemplateUpdateParameters or IO) – Update parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

EmailTemplateContract or the result of cls(response)

Return type

EmailTemplateContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.GatewayApiOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s gateway_api attribute.

create_or_update(resource_group_name: str, service_name: str, gateway_id: str, api_id: str, parameters: Optional[_models.AssociationContract] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ApiContract

create_or_update(resource_group_name: str, service_name: str, gateway_id: str, api_id: str, parameters: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ApiContract

Adds an API to the specified Gateway.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

• parameters (AssociationContract or IO) – Is either a model type or a IO type. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

ApiContract or the result of cls(response)

Return type

ApiContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, gateway_id: str, api_id: str, **kwargs: Any) → None

Deletes the specified API from the specified Gateway.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, gateway_id: str, api_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

• api_id (str) – API identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, gateway_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ApiContract]

Lists a collection of the APIs associated with a gateway.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  functions |</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ApiContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.GatewayCertificateAuthorityOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s gateway_certificate_authority attribute.

create_or_update(resource_group_name: str, service_name: str, gateway_id: str, certificate_id: str, parameters: _models.GatewayCertificateAuthorityContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GatewayCertificateAuthorityContract

create_or_update(resource_group_name: str, service_name: str, gateway_id: str, certificate_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GatewayCertificateAuthorityContract

Assign Certificate entity to Gateway entity as Certificate Authority.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

• certificate_id (str) – Identifier of the certificate entity. Must be unique in the current API Management service instance. Required.

• parameters (GatewayCertificateAuthorityContract or IO) – Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

GatewayCertificateAuthorityContract or the result of cls(response)

Return type

GatewayCertificateAuthorityContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, gateway_id: str, certificate_id: str, if_match: str, **kwargs: Any) → None

Remove relationship between Certificate Authority and Gateway entity.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

• certificate_id (str) – Identifier of the certificate entity. Must be unique in the current API Management service instance. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, gateway_id: str, certificate_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.GatewayCertificateAuthorityContract

Get assigned Gateway Certificate Authority details.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

• certificate_id (str) – Identifier of the certificate entity. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

GatewayCertificateAuthorityContract or the result of cls(response)

Return type

GatewayCertificateAuthorityContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, gateway_id: str, certificate_id: str, **kwargs: Any) → bool

Checks if Certificate entity is assigned to Gateway entity as Certificate Authority.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

• certificate_id (str) – Identifier of the certificate entity. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, gateway_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.GatewayCertificateAuthorityContract]

Lists the collection of Certificate Authorities for the specified Gateway entity.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  functions |</br>|————-|-------------|————-|-------------|</br>| name | filter | eq, ne | |</br>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[GatewayCertificateAuthorityContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.GatewayHostnameConfigurationOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s gateway_hostname_configuration attribute.

create_or_update(resource_group_name: str, service_name: str, gateway_id: str, hc_id: str, parameters: _models.GatewayHostnameConfigurationContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GatewayHostnameConfigurationContract

create_or_update(resource_group_name: str, service_name: str, gateway_id: str, hc_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GatewayHostnameConfigurationContract

Creates of updates hostname configuration for a Gateway.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

• hc_id (str) – Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity. Required.

• parameters (GatewayHostnameConfigurationContract or IO) – Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

GatewayHostnameConfigurationContract or the result of cls(response)

Return type

GatewayHostnameConfigurationContract

Raises

HttpResponseError –

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

Deletes the specified hostname configuration from the specified Gateway.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

• hc_id (str) – Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, gateway_id: str, hc_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.GatewayHostnameConfigurationContract

Get details of a hostname configuration.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

• hc_id (str) – Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity. Required.

Keyword Arguments

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

Returns

GatewayHostnameConfigurationContract or the result of cls(response)

Return type

GatewayHostnameConfigurationContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, gateway_id: str, hc_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

• hc_id (str) – Gateway hostname configuration identifier. Must be unique in the scope of parent Gateway entity. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, gateway_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.GatewayHostnameConfigurationContract]

Lists the collection of hostname configurations for the specified gateway.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  functions |</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| hostname | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[GatewayHostnameConfigurationContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.GatewayOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s gateway attribute.

create_or_update(resource_group_name: str, service_name: str, gateway_id: str, parameters: _models.GatewayContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GatewayContract

create_or_update(resource_group_name: str, service_name: str, gateway_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GatewayContract

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

• parameters (GatewayContract or IO) – Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

GatewayContract or the result of cls(response)

Return type

GatewayContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, gateway_id: str, if_match: str, **kwargs: Any) → None

Deletes specific Gateway.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

generate_token(resource_group_name: str, service_name: str, gateway_id: str, parameters: _models.GatewayTokenRequestContract, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GatewayTokenContract

generate_token(resource_group_name: str, service_name: str, gateway_id: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GatewayTokenContract

Gets the Shared Access Authorization Token for the gateway.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

• parameters (GatewayTokenRequestContract or IO) – Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

GatewayTokenContract or the result of cls(response)

Return type

GatewayTokenContract

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, gateway_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.GatewayContract

Gets the details of the Gateway specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

Keyword Arguments

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

Returns

GatewayContract or the result of cls(response)

Return type

GatewayContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, gateway_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.GatewayContract]

Lists a collection of gateways registered with service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  functions |</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>| region | 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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[GatewayContract]

Raises

HttpResponseError –

list_keys(resource_group_name: str, service_name: str, gateway_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.GatewayKeysContract

Retrieves gateway keys.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

Keyword Arguments

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

Returns

GatewayKeysContract or the result of cls(response)

Return type

GatewayKeysContract

Raises

HttpResponseError –

regenerate_key(resource_group_name: str, service_name: str, gateway_id: str, parameters: _models.GatewayKeyRegenerationRequestContract, *, content_type: str = "'application/json'", **kwargs: Any) → None

regenerate_key(resource_group_name: str, service_name: str, gateway_id: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → None

Regenerates specified gateway key invalidating any tokens created with it.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

• parameters (GatewayKeyRegenerationRequestContract or IO) – Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, gateway_id: str, if_match: str, parameters: _models.GatewayContract, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GatewayContract

update(resource_group_name: str, service_name: str, gateway_id: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GatewayContract

Updates the details of the gateway specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• gateway_id (str) – Gateway entity identifier. Must be unique in the current API Management service instance. Must not have value ‘managed’. Required.

• 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. Required.

• parameters (GatewayContract or IO) – Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

GatewayContract or the result of cls(response)

Return type

GatewayContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.GlobalSchemaOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s global_schema attribute.

begin_create_or_update(resource_group_name: str, service_name: str, schema_id: str, parameters: _models.GlobalSchemaContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GlobalSchemaContract]

begin_create_or_update(resource_group_name: str, service_name: str, schema_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.GlobalSchemaContract]

Creates new or updates existing specified Schema of the API Management service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• schema_id (str) – Schema id identifier. Must be unique in the current API Management service instance. Required.

• parameters (GlobalSchemaContract or IO) – Create or update parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[GlobalSchemaContract]

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, schema_id: str, if_match: str, **kwargs: Any) → None

Deletes specific Schema.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• schema_id (str) – Schema id identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, schema_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.GlobalSchemaContract

Gets the details of the Schema specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• schema_id (str) – Schema id identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

GlobalSchemaContract or the result of cls(response)

Return type

GlobalSchemaContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, schema_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• schema_id (str) – Schema id identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.GlobalSchemaContract]

Lists a collection of schemas registered with service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  functions |</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |</br>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[GlobalSchemaContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.GroupOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s group attribute.

create_or_update(resource_group_name: str, service_name: str, group_id: str, parameters: _models.GroupCreateParameters, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GroupContract

create_or_update(resource_group_name: str, service_name: str, group_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GroupContract

Creates or Updates a group.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• group_id (str) – Group identifier. Must be unique in the current API Management service instance. Required.

• parameters (GroupCreateParameters or IO) – Create parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

GroupContract or the result of cls(response)

Return type

GroupContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, group_id: str, if_match: str, **kwargs: Any) → None

Deletes specific group of the API Management service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• group_id (str) – Group identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, group_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.GroupContract

Gets the details of the group specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• group_id (str) – Group identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

GroupContract or the result of cls(response)

Return type

GroupContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, group_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• group_id (str) – Group identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.GroupContract]

Lists a collection of groups defined within a service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>| externalId | filter | eq | |</br>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[GroupContract]

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, group_id: str, if_match: str, parameters: _models.GroupUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GroupContract

update(resource_group_name: str, service_name: str, group_id: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.GroupContract

Updates the details of the group specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• group_id (str) – Group identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

• parameters (GroupUpdateParameters or IO) – Update parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

GroupContract or the result of cls(response)

Return type

GroupContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.GroupUserOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s group_user attribute.

check_entity_exists(resource_group_name: str, service_name: str, group_id: str, user_id: str, **kwargs: Any) → bool

Checks that user entity specified by identifier is associated with the group entity.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• group_id (str) – Group identifier. Must be unique in the current API Management service instance. Required.

• user_id (str) – User identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

create(resource_group_name: str, service_name: str, group_id: str, user_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.UserContract

Add existing user to existing group.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• group_id (str) – Group identifier. Must be unique in the current API Management service instance. Required.

• user_id (str) – User identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

UserContract or the result of cls(response)

Return type

UserContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, group_id: str, user_id: str, **kwargs: Any) → None

Remove existing user from existing group.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• group_id (str) – Group identifier. Must be unique in the current API Management service instance. Required.

• user_id (str) – User identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

list(resource_group_name: str, service_name: str, group_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.UserContract]

Lists a collection of user entities associated with the group.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• group_id (str) – Group identifier. Must be unique in the current API Management service instance. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[UserContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.IdentityProviderOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s identity_provider attribute.

create_or_update(resource_group_name: str, service_name: str, identity_provider_name: Union[str, _models.IdentityProviderType], parameters: _models.IdentityProviderCreateContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IdentityProviderContract

create_or_update(resource_group_name: str, service_name: str, identity_provider_name: Union[str, _models.IdentityProviderType], parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IdentityProviderContract

Creates or Updates the IdentityProvider configuration.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• identity_provider_name (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”. Required.

• parameters (IdentityProviderCreateContract or IO) – Create parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

IdentityProviderContract or the result of cls(response)

Return type

IdentityProviderContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, identity_provider_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.IdentityProviderType], if_match: str, **kwargs: Any) → None

Deletes the specified identity provider configuration.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• identity_provider_name (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, identity_provider_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.IdentityProviderType], **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.IdentityProviderContract

Gets the configuration details of the identity Provider configured in specified service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• identity_provider_name (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”. Required.

Keyword Arguments

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

Returns

IdentityProviderContract or the result of cls(response)

Return type

IdentityProviderContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, identity_provider_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.IdentityProviderType], **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• identity_provider_name (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.IdentityProviderContract]

Lists a collection of Identity Provider configured in the specified service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[IdentityProviderContract]

Raises

HttpResponseError –

list_secrets(resource_group_name: str, service_name: str, identity_provider_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.IdentityProviderType], **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.ClientSecretContract

Gets the client secret details of the Identity Provider.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• identity_provider_name (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”. Required.

Keyword Arguments

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

Returns

ClientSecretContract or the result of cls(response)

Return type

ClientSecretContract

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, identity_provider_name: Union[str, _models.IdentityProviderType], if_match: str, parameters: _models.IdentityProviderUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IdentityProviderContract

update(resource_group_name: str, service_name: str, identity_provider_name: Union[str, _models.IdentityProviderType], if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.IdentityProviderContract

Updates an existing IdentityProvider configuration.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• identity_provider_name (str or IdentityProviderType) – Identity Provider Type identifier. Known values are: “facebook”, “google”, “microsoft”, “twitter”, “aad”, and “aadB2C”. Required.

• 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. Required.

• parameters (IdentityProviderUpdateParameters or IO) – Update parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

IdentityProviderContract or the result of cls(response)

Return type

IdentityProviderContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.IssueOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s issue attribute.

get(resource_group_name: str, service_name: str, issue_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.IssueContract

Gets API Management issue details.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• issue_id (str) – Issue identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

IssueContract or the result of cls(response)

Return type

IssueContract

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.IssueContract]

Lists a collection of issues in the specified service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[IssueContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.LoggerOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s logger attribute.

create_or_update(resource_group_name: str, service_name: str, logger_id: str, parameters: _models.LoggerContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LoggerContract

create_or_update(resource_group_name: str, service_name: str, logger_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LoggerContract

Creates or Updates a logger.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• logger_id (str) – Logger identifier. Must be unique in the API Management service instance. Required.

• parameters (LoggerContract or IO) – Create parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

LoggerContract or the result of cls(response)

Return type

LoggerContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, logger_id: str, if_match: str, **kwargs: Any) → None

Deletes the specified logger.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• logger_id (str) – Logger identifier. Must be unique in the API Management service instance. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, logger_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.LoggerContract

Gets the details of the logger specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• logger_id (str) – Logger identifier. Must be unique in the API Management service instance. Required.

Keyword Arguments

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

Returns

LoggerContract or the result of cls(response)

Return type

LoggerContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, logger_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• logger_id (str) – Logger identifier. Must be unique in the API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.LoggerContract]

Lists a collection of loggers in the specified service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[LoggerContract]

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, logger_id: str, if_match: str, parameters: _models.LoggerUpdateContract, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LoggerContract

update(resource_group_name: str, service_name: str, logger_id: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.LoggerContract

Updates an existing logger.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• logger_id (str) – Logger identifier. Must be unique in the API Management service instance. Required.

• 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. Required.

• parameters (LoggerUpdateContract or IO) – Update parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

LoggerContract or the result of cls(response)

Return type

LoggerContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.NamedValueOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s named_value attribute.

begin_create_or_update(resource_group_name: str, service_name: str, named_value_id: str, parameters: _models.NamedValueCreateContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NamedValueContract]

begin_create_or_update(resource_group_name: str, service_name: str, named_value_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NamedValueContract]

Creates or updates named value.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• named_value_id (str) – Identifier of the NamedValue. Required.

• parameters (NamedValueCreateContract or IO) – Create parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[NamedValueContract]

Raises

HttpResponseError –

begin_refresh_secret(resource_group_name: str, service_name: str, named_value_id: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.apimanagement.models._models_py3.NamedValueContract]

Refresh the secret of the named value specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• named_value_id (str) – Identifier of the NamedValue. Required.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[NamedValueContract]

Raises

HttpResponseError –

begin_update(resource_group_name: str, service_name: str, named_value_id: str, if_match: str, parameters: _models.NamedValueUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NamedValueContract]

begin_update(resource_group_name: str, service_name: str, named_value_id: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.NamedValueContract]

Updates the specific named value.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• named_value_id (str) – Identifier of the NamedValue. Required.

• 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. Required.

• parameters (NamedValueUpdateParameters or IO) – Update parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[NamedValueContract]

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, named_value_id: str, if_match: str, **kwargs: Any) → None

Deletes specific named value from the API Management service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• named_value_id (str) – Identifier of the NamedValue. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, named_value_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.NamedValueContract

Gets the details of the named value specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• named_value_id (str) – Identifier of the NamedValue. Required.

Keyword Arguments

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

Returns

NamedValueContract or the result of cls(response)

Return type

NamedValueContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, named_value_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• named_value_id (str) – Identifier of the NamedValue. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, is_key_vault_refresh_failed: Optional[bool] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.NamedValueContract]

Lists a collection of named values defined within a service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

• is_key_vault_refresh_failed (bool) – When set to true, the response contains only named value entities which failed refresh. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[NamedValueContract]

Raises

HttpResponseError –

list_value(resource_group_name: str, service_name: str, named_value_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.NamedValueSecretContract

Gets the secret of the named value specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• named_value_id (str) – Identifier of the NamedValue. Required.

Keyword Arguments

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

Returns

NamedValueSecretContract or the result of cls(response)

Return type

NamedValueSecretContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.NetworkStatusOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s network_status attribute.

list_by_location(resource_group_name: str, service_name: str, location_name: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.NetworkStatusContract

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. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

Keyword Arguments

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

Returns

NetworkStatusContract or the result of cls(response)

Return type

NetworkStatusContract

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, **kwargs: Any) → List[azure.mgmt.apimanagement.models._models_py3.NetworkStatusContractByLocation]

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. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

Returns

list of NetworkStatusContractByLocation or the result of cls(response)

Return type

list[NetworkStatusContractByLocation]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.NotificationOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s notification attribute.

create_or_update(resource_group_name: str, service_name: str, notification_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.NotificationName], if_match: Optional[str] = None, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.NotificationContract

Create or Update API Management publisher notification.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• notification_name (str or NotificationName) – Notification Name Identifier. Known values are: “RequestPublisherNotificationMessage”, “PurchasePublisherNotificationMessage”, “NewApplicationNotificationMessage”, “BCC”, “NewIssuePublisherNotificationMessage”, “AccountClosedPublisher”, and “QuotaLimitApproachingPublisherNotificationMessage”. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

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

Returns

NotificationContract or the result of cls(response)

Return type

NotificationContract

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, notification_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.NotificationName], **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.NotificationContract

Gets the details of the Notification specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• notification_name (str or NotificationName) – Notification Name Identifier. Known values are: “RequestPublisherNotificationMessage”, “PurchasePublisherNotificationMessage”, “NewApplicationNotificationMessage”, “BCC”, “NewIssuePublisherNotificationMessage”, “AccountClosedPublisher”, and “QuotaLimitApproachingPublisherNotificationMessage”. Required.

Keyword Arguments

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

Returns

NotificationContract or the result of cls(response)

Return type

NotificationContract

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.NotificationContract]

Lists a collection of properties defined within a service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[NotificationContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.NotificationRecipientEmailOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s notification_recipient_email attribute.

check_entity_exists(resource_group_name: str, service_name: str, notification_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.NotificationName], email: str, **kwargs: Any) → bool

Determine if Notification Recipient Email subscribed to the notification.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• notification_name (str or NotificationName) – Notification Name Identifier. Known values are: “RequestPublisherNotificationMessage”, “PurchasePublisherNotificationMessage”, “NewApplicationNotificationMessage”, “BCC”, “NewIssuePublisherNotificationMessage”, “AccountClosedPublisher”, and “QuotaLimitApproachingPublisherNotificationMessage”. Required.

• email (str) – Email identifier. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

create_or_update(resource_group_name: str, service_name: str, notification_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.NotificationName], email: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.RecipientEmailContract

Adds the Email address to the list of Recipients for the Notification.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• notification_name (str or NotificationName) – Notification Name Identifier. Known values are: “RequestPublisherNotificationMessage”, “PurchasePublisherNotificationMessage”, “NewApplicationNotificationMessage”, “BCC”, “NewIssuePublisherNotificationMessage”, “AccountClosedPublisher”, and “QuotaLimitApproachingPublisherNotificationMessage”. Required.

• email (str) – Email identifier. Required.

Keyword Arguments

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

Returns

RecipientEmailContract or the result of cls(response)

Return type

RecipientEmailContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, notification_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.NotificationName], email: str, **kwargs: Any) → None

Removes the email from the list of Notification.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• notification_name (str or NotificationName) – Notification Name Identifier. Known values are: “RequestPublisherNotificationMessage”, “PurchasePublisherNotificationMessage”, “NewApplicationNotificationMessage”, “BCC”, “NewIssuePublisherNotificationMessage”, “AccountClosedPublisher”, and “QuotaLimitApproachingPublisherNotificationMessage”. Required.

• email (str) – Email identifier. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

list_by_notification(resource_group_name: str, service_name: str, notification_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.NotificationName], **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.RecipientEmailCollection

Gets the list of the Notification Recipient Emails subscribed to a notification.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• notification_name (str or NotificationName) – Notification Name Identifier. Known values are: “RequestPublisherNotificationMessage”, “PurchasePublisherNotificationMessage”, “NewApplicationNotificationMessage”, “BCC”, “NewIssuePublisherNotificationMessage”, “AccountClosedPublisher”, and “QuotaLimitApproachingPublisherNotificationMessage”. Required.

Keyword Arguments

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

Returns

RecipientEmailCollection or the result of cls(response)

Return type

RecipientEmailCollection

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.NotificationRecipientUserOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s notification_recipient_user attribute.

check_entity_exists(resource_group_name: str, service_name: str, notification_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.NotificationName], user_id: str, **kwargs: Any) → bool

Determine if the Notification Recipient User is subscribed to the notification.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• notification_name (str or NotificationName) – Notification Name Identifier. Known values are: “RequestPublisherNotificationMessage”, “PurchasePublisherNotificationMessage”, “NewApplicationNotificationMessage”, “BCC”, “NewIssuePublisherNotificationMessage”, “AccountClosedPublisher”, and “QuotaLimitApproachingPublisherNotificationMessage”. Required.

• user_id (str) – User identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

create_or_update(resource_group_name: str, service_name: str, notification_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.NotificationName], user_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.RecipientUserContract

Adds the API Management User to the list of Recipients for the Notification.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• notification_name (str or NotificationName) – Notification Name Identifier. Known values are: “RequestPublisherNotificationMessage”, “PurchasePublisherNotificationMessage”, “NewApplicationNotificationMessage”, “BCC”, “NewIssuePublisherNotificationMessage”, “AccountClosedPublisher”, and “QuotaLimitApproachingPublisherNotificationMessage”. Required.

• user_id (str) – User identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

RecipientUserContract or the result of cls(response)

Return type

RecipientUserContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, notification_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.NotificationName], user_id: str, **kwargs: Any) → None

Removes the API Management user from the list of Notification.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• notification_name (str or NotificationName) – Notification Name Identifier. Known values are: “RequestPublisherNotificationMessage”, “PurchasePublisherNotificationMessage”, “NewApplicationNotificationMessage”, “BCC”, “NewIssuePublisherNotificationMessage”, “AccountClosedPublisher”, and “QuotaLimitApproachingPublisherNotificationMessage”. Required.

• user_id (str) – User identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

list_by_notification(resource_group_name: str, service_name: str, notification_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.NotificationName], **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.RecipientUserCollection

Gets the list of the Notification Recipient User subscribed to the notification.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• notification_name (str or NotificationName) – Notification Name Identifier. Known values are: “RequestPublisherNotificationMessage”, “PurchasePublisherNotificationMessage”, “NewApplicationNotificationMessage”, “BCC”, “NewIssuePublisherNotificationMessage”, “AccountClosedPublisher”, and “QuotaLimitApproachingPublisherNotificationMessage”. Required.

Keyword Arguments

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

Returns

RecipientUserCollection or the result of cls(response)

Return type

RecipientUserCollection

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.OpenIdConnectProviderOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s open_id_connect_provider attribute.

create_or_update(resource_group_name: str, service_name: str, opid: str, parameters: _models.OpenidConnectProviderContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.OpenidConnectProviderContract

create_or_update(resource_group_name: str, service_name: str, opid: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.OpenidConnectProviderContract

Creates or updates the OpenID Connect Provider.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• opid (str) – Identifier of the OpenID Connect Provider. Required.

• parameters (OpenidConnectProviderContract or IO) – Create parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

OpenidConnectProviderContract or the result of cls(response)

Return type

OpenidConnectProviderContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, opid: str, if_match: str, **kwargs: Any) → None

Deletes specific OpenID Connect Provider of the API Management service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• opid (str) – Identifier of the OpenID Connect Provider. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, opid: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.OpenidConnectProviderContract

Gets specific OpenID Connect Provider without secrets.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• opid (str) – Identifier of the OpenID Connect Provider. Required.

Keyword Arguments

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

Returns

OpenidConnectProviderContract or the result of cls(response)

Return type

OpenidConnectProviderContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, opid: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• opid (str) – Identifier of the OpenID Connect Provider. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.OpenidConnectProviderContract]

Lists of all the OpenId Connect Providers.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[OpenidConnectProviderContract]

Raises

HttpResponseError –

list_secrets(resource_group_name: str, service_name: str, opid: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.ClientSecretContract

Gets the client secret details of the OpenID Connect Provider.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• opid (str) – Identifier of the OpenID Connect Provider. Required.

Keyword Arguments

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

Returns

ClientSecretContract or the result of cls(response)

Return type

ClientSecretContract

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, opid: str, if_match: str, parameters: _models.OpenidConnectProviderUpdateContract, *, content_type: str = "'application/json'", **kwargs: Any) → _models.OpenidConnectProviderContract

update(resource_group_name: str, service_name: str, opid: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.OpenidConnectProviderContract

Updates the specific OpenID Connect Provider.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• opid (str) – Identifier of the OpenID Connect Provider. Required.

• 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. Required.

• parameters (OpenidConnectProviderUpdateContract or IO) – Update parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

OpenidConnectProviderContract or the result of cls(response)

Return type

OpenidConnectProviderContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.OperationOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s operation attribute.

list_by_tags(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, include_not_tagged_operations: Optional[bool] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.TagResourceContract]

Lists a collection of operations associated with tags.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

• include_not_tagged_operations (bool) – Include not tagged Operations. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[TagResourceContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.OutboundNetworkDependenciesEndpointsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s outbound_network_dependencies_endpoints attribute.

list_by_service(resource_group_name: str, service_name: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.OutboundEnvironmentEndpointList

Gets the network endpoints of all outbound dependencies of a ApiManagement service.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

Returns

OutboundEnvironmentEndpointList or the result of cls(response)

Return type

OutboundEnvironmentEndpointList

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.PolicyDescriptionOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s policy_description attribute.

list_by_service(resource_group_name: str, service_name: str, scope: Optional[Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.PolicyScopeContract]] = None, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.PolicyDescriptionCollection

Lists all policy descriptions.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• scope (str or PolicyScopeContract) – Policy scope. Known values are: “Tenant”, “Product”, “Api”, “Operation”, and “All”. Default value is None.

Keyword Arguments

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

Returns

PolicyDescriptionCollection or the result of cls(response)

Return type

PolicyDescriptionCollection

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.PolicyOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s policy attribute.

create_or_update(resource_group_name: str, service_name: str, policy_id: Union[str, _models.PolicyIdName], parameters: _models.PolicyContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PolicyContract

create_or_update(resource_group_name: str, service_name: str, policy_id: Union[str, _models.PolicyIdName], parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PolicyContract

Creates or updates the global policy configuration of the Api Management service.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• policy_id (str or PolicyIdName) – The identifier of the Policy. “policy” Required.

• parameters (PolicyContract or IO) – The policy contents to apply. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

PolicyContract or the result of cls(response)

Return type

PolicyContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, policy_id: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.PolicyIdName], if_match: str, **kwargs: Any) → None

Deletes the global policy configuration of the Api Management Service.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• policy_id (str or PolicyIdName) – The identifier of the Policy. “policy” Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, policy_id: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.PolicyIdName], format: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.PolicyExportFormat] = 'xml', **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.PolicyContract

Get the Global policy definition of the Api Management service.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• policy_id (str or PolicyIdName) – The identifier of the Policy. “policy” Required.

• format (str or PolicyExportFormat) – Policy Export Format. Known values are: “xml” and “rawxml”. Default value is “xml”.

Keyword Arguments

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

Returns

PolicyContract or the result of cls(response)

Return type

PolicyContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, policy_id: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.PolicyIdName], **kwargs: Any) → bool

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. Required.

• service_name (str) – The name of the API Management service. Required.

• policy_id (str or PolicyIdName) – The identifier of the Policy. “policy” Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.PolicyCollection

Lists all the Global Policy definitions of the Api Management service.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

Returns

PolicyCollection or the result of cls(response)

Return type

PolicyCollection

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.PortalRevisionOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s portal_revision attribute.

begin_create_or_update(resource_group_name: str, service_name: str, portal_revision_id: str, parameters: _models.PortalRevisionContract, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PortalRevisionContract]

begin_create_or_update(resource_group_name: str, service_name: str, portal_revision_id: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PortalRevisionContract]

Creates a new developer portal’s revision by running the portal’s publishing. The isCurrent property indicates if the revision is publicly accessible.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• portal_revision_id (str) – Portal revision identifier. Must be unique in the current API Management service instance. Required.

• parameters (PortalRevisionContract or IO) – Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[PortalRevisionContract]

Raises

HttpResponseError –

begin_update(resource_group_name: str, service_name: str, portal_revision_id: str, if_match: str, parameters: _models.PortalRevisionContract, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PortalRevisionContract]

begin_update(resource_group_name: str, service_name: str, portal_revision_id: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PortalRevisionContract]

Updates the description of specified portal revision or makes it current.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• portal_revision_id (str) – Portal revision identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

• parameters (PortalRevisionContract or IO) – Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[PortalRevisionContract]

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, portal_revision_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.PortalRevisionContract

Gets the developer portal’s revision specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• portal_revision_id (str) – Portal revision identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

PortalRevisionContract or the result of cls(response)

Return type

PortalRevisionContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, portal_revision_id: str, **kwargs: Any) → bool

Gets the developer portal revision specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• portal_revision_id (str) – Portal revision identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.PortalRevisionContract]

Lists developer portal’s revisions.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  |name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith| |isCurrent | eq, ne | |. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PortalRevisionContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.PortalSettingsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s portal_settings attribute.

list_by_service(resource_group_name: str, service_name: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.PortalSettingsCollection

Lists a collection of portalsettings defined within a service instance..

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

Returns

PortalSettingsCollection or the result of cls(response)

Return type

PortalSettingsCollection

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.PrivateEndpointConnectionOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s private_endpoint_connection attribute.

begin_create_or_update(resource_group_name: str, service_name: str, private_endpoint_connection_name: str, private_endpoint_connection_request: _models.PrivateEndpointConnectionRequest, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection]

begin_create_or_update(resource_group_name: str, service_name: str, private_endpoint_connection_name: str, private_endpoint_connection_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.PrivateEndpointConnection]

Creates a new Private Endpoint Connection or updates an existing one.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• private_endpoint_connection_name (str) – Name of the private endpoint connection. Required.

• private_endpoint_connection_request (PrivateEndpointConnectionRequest or IO) – Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[PrivateEndpointConnection]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, service_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Deletes the specified Private Endpoint Connection.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• private_endpoint_connection_name (str) – Name of the private endpoint connection. Required.

Keyword Arguments

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[None]

Raises

HttpResponseError –

get_by_name(resource_group_name: str, service_name: str, private_endpoint_connection_name: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.PrivateEndpointConnection

Gets the details of the Private Endpoint Connection specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• private_endpoint_connection_name (str) – Name of the private endpoint connection. Required.

Keyword Arguments

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

Returns

PrivateEndpointConnection or the result of cls(response)

Return type

PrivateEndpointConnection

Raises

HttpResponseError –

get_private_link_resource(resource_group_name: str, service_name: str, private_link_sub_resource_name: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.PrivateLinkResource

Gets the private link resources.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• private_link_sub_resource_name (str) – Name of the private link resource. Required.

Keyword Arguments

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

Returns

PrivateLinkResource or the result of cls(response)

Return type

PrivateLinkResource

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.PrivateEndpointConnection]

Lists all private endpoint connections of the API Management service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[PrivateEndpointConnection]

Raises

HttpResponseError –

list_private_link_resources(resource_group_name: str, service_name: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.PrivateLinkResourceListResult

Gets the private link resources.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

Returns

PrivateLinkResourceListResult or the result of cls(response)

Return type

PrivateLinkResourceListResult

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ProductApiOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s product_api attribute.

check_entity_exists(resource_group_name: str, service_name: str, product_id: str, api_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

create_or_update(resource_group_name: str, service_name: str, product_id: str, api_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.ApiContract

Adds an API to the specified product.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

Keyword Arguments

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

Returns

ApiContract or the result of cls(response)

Return type

ApiContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, product_id: str, api_id: str, **kwargs: Any) → None

Deletes the specified API from the specified product.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

list_by_product(resource_group_name: str, service_name: str, product_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ApiContract]

Lists a collection of the APIs associated with a product.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ApiContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ProductGroupOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s product_group attribute.

check_entity_exists(resource_group_name: str, service_name: str, product_id: str, group_id: str, **kwargs: Any) → bool

Checks that Group entity specified by identifier is associated with the Product entity.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• group_id (str) – Group identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

create_or_update(resource_group_name: str, service_name: str, product_id: str, group_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.GroupContract

Adds the association between the specified developer group with the specified product.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• group_id (str) – Group identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

GroupContract or the result of cls(response)

Return type

GroupContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, product_id: str, group_id: str, **kwargs: Any) → None

Deletes the association between the specified group and product.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• group_id (str) – Group identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

list_by_product(resource_group_name: str, service_name: str, product_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.GroupContract]

Lists the collection of developer groups associated with the specified product.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  functions |</br>|————-|-------------|————-|-------------|</br>| name | filter | ge, le, eq, ne, gt, lt | |</br>| displayName | filter | eq, ne | |</br>| description | filter | eq, ne | |</br>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[GroupContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ProductOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s product attribute.

create_or_update(resource_group_name: str, service_name: str, product_id: str, parameters: _models.ProductContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProductContract

create_or_update(resource_group_name: str, service_name: str, product_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProductContract

Creates or Updates a product.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• parameters (ProductContract or IO) – Create or update parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

ProductContract or the result of cls(response)

Return type

ProductContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, product_id: str, if_match: str, delete_subscriptions: Optional[bool] = None, **kwargs: Any) → None

Delete product.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

• delete_subscriptions (bool) – Delete existing subscriptions associated with the product or not. Default value is None.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, product_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.ProductContract

Gets the details of the product specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

ProductContract or the result of cls(response)

Return type

ProductContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, product_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, expand_groups: Optional[bool] = None, tags: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ProductContract]

Lists a collection of products in the specified service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

• expand_groups (bool) – When set to true, the response contains an array of groups that have visibility to the product. The default is false. Default value is None.

• tags (str) – Products which are part of a specific tag. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ProductContract]

Raises

HttpResponseError –

list_by_tags(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, include_not_tagged_products: Optional[bool] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.TagResourceContract]

Lists a collection of products associated with tags.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

• include_not_tagged_products (bool) – Include not tagged Products. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[TagResourceContract]

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, product_id: str, if_match: str, parameters: _models.ProductUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProductContract

update(resource_group_name: str, service_name: str, product_id: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ProductContract

Update existing product details.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

• parameters (ProductUpdateParameters or IO) – Update parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

ProductContract or the result of cls(response)

Return type

ProductContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ProductPolicyOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s product_policy attribute.

create_or_update(resource_group_name: str, service_name: str, product_id: str, policy_id: Union[str, _models.PolicyIdName], parameters: _models.PolicyContract, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PolicyContract

create_or_update(resource_group_name: str, service_name: str, product_id: str, policy_id: Union[str, _models.PolicyIdName], parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PolicyContract

Creates or updates policy configuration for the Product.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• policy_id (str or PolicyIdName) – The identifier of the Policy. “policy” Required.

• parameters (PolicyContract or IO) – The policy contents to apply. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

PolicyContract or the result of cls(response)

Return type

PolicyContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, product_id: str, policy_id: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.PolicyIdName], if_match: str, **kwargs: Any) → None

Deletes the policy configuration at the Product.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• policy_id (str or PolicyIdName) – The identifier of the Policy. “policy” Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, product_id: str, policy_id: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.PolicyIdName], format: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.PolicyExportFormat] = 'xml', **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.PolicyContract

Get the policy configuration at the Product level.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• policy_id (str or PolicyIdName) – The identifier of the Policy. “policy” Required.

• format (str or PolicyExportFormat) – Policy Export Format. Known values are: “xml” and “rawxml”. Default value is “xml”.

Keyword Arguments

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

Returns

PolicyContract or the result of cls(response)

Return type

PolicyContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, product_id: str, policy_id: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.PolicyIdName], **kwargs: Any) → bool

Get the ETag of the policy configuration at the Product level.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• policy_id (str or PolicyIdName) – The identifier of the Policy. “policy” Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_product(resource_group_name: str, service_name: str, product_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.PolicyCollection

Get the policy configuration at the Product level.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

PolicyCollection or the result of cls(response)

Return type

PolicyCollection

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ProductSubscriptionsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s product_subscriptions attribute.

list(resource_group_name: str, service_name: str, product_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.SubscriptionContract]

Lists the collection of subscriptions to the specified product.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SubscriptionContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.QuotaByCounterKeysOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s quota_by_counter_keys attribute.

list_by_service(resource_group_name: str, service_name: str, quota_counter_key: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.QuotaCounterCollection

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. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

Keyword Arguments

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

Returns

QuotaCounterCollection or the result of cls(response)

Return type

QuotaCounterCollection

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, quota_counter_key: str, parameters: _models.QuotaCounterValueUpdateContract, *, content_type: str = "'application/json'", **kwargs: Any) → _models.QuotaCounterCollection

update(resource_group_name: str, service_name: str, quota_counter_key: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.QuotaCounterCollection

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. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• parameters (QuotaCounterValueUpdateContract or IO) – The value of the quota counter to be applied to all quota counter periods. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

QuotaCounterCollection or the result of cls(response)

Return type

QuotaCounterCollection

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.QuotaByPeriodKeysOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s quota_by_period_keys attribute.

get(resource_group_name: str, service_name: str, quota_counter_key: str, quota_period_key: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.QuotaCounterContract

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. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• quota_period_key (str) – Quota period key identifier. Required.

Keyword Arguments

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

Returns

QuotaCounterContract or the result of cls(response)

Return type

QuotaCounterContract

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, quota_counter_key: str, quota_period_key: str, parameters: _models.QuotaCounterValueUpdateContract, *, content_type: str = "'application/json'", **kwargs: Any) → _models.QuotaCounterContract

update(resource_group_name: str, service_name: str, quota_counter_key: str, quota_period_key: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.QuotaCounterContract

Updates an existing quota counter value in the specified service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• quota_period_key (str) – Quota period key identifier. Required.

• parameters (QuotaCounterValueUpdateContract or IO) – The value of the Quota counter to be applied on the specified period. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

QuotaCounterContract or the result of cls(response)

Return type

QuotaCounterContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.RegionOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s region attribute.

list_by_service(resource_group_name: str, service_name: str, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.RegionContract]

Lists all azure regions in which the service exists.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RegionContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.ReportsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s reports attribute.

list_by_api(resource_group_name: str, service_name: str, filter: str, top: Optional[int] = None, skip: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ReportRecordContract]

Lists report records by API.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) – The filter to apply on the operation. Required.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

• orderby (str) – OData order by query option. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ReportRecordContract]

Raises

HttpResponseError –

list_by_geo(resource_group_name: str, service_name: str, filter: str, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ReportRecordContract]

Lists report records by geography.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Required.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ReportRecordContract]

Raises

HttpResponseError –

list_by_operation(resource_group_name: str, service_name: str, filter: str, top: Optional[int] = None, skip: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ReportRecordContract]

Lists report records by API Operations.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Required.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

• orderby (str) – OData order by query option. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ReportRecordContract]

Raises

HttpResponseError –

list_by_product(resource_group_name: str, service_name: str, filter: str, top: Optional[int] = None, skip: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ReportRecordContract]

Lists report records by Product.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Required.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

• orderby (str) – OData order by query option. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ReportRecordContract]

Raises

HttpResponseError –

list_by_request(resource_group_name: str, service_name: str, filter: str, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.RequestReportRecordContract]

Lists report records by Request.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Required.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[RequestReportRecordContract]

Raises

HttpResponseError –

list_by_subscription(resource_group_name: str, service_name: str, filter: str, top: Optional[int] = None, skip: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ReportRecordContract]

Lists report records by subscription.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Required.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

• orderby (str) – OData order by query option. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ReportRecordContract]

Raises

HttpResponseError –

list_by_time(resource_group_name: str, service_name: str, filter: str, interval: datetime.timedelta, top: Optional[int] = None, skip: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ReportRecordContract]

Lists report records by Time.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Required.

• 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)). Required.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

• orderby (str) – OData order by query option. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ReportRecordContract]

Raises

HttpResponseError –

list_by_user(resource_group_name: str, service_name: str, filter: str, top: Optional[int] = None, skip: Optional[int] = None, orderby: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.ReportRecordContract]

Lists report records by User.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Required.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

• orderby (str) – OData order by query option. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[ReportRecordContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.SignInSettingsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s sign_in_settings attribute.

create_or_update(resource_group_name: str, service_name: str, parameters: _models.PortalSigninSettings, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PortalSigninSettings

create_or_update(resource_group_name: str, service_name: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PortalSigninSettings

Create or Update Sign-In settings.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• parameters (PortalSigninSettings or IO) – Create or update parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

PortalSigninSettings or the result of cls(response)

Return type

PortalSigninSettings

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.PortalSigninSettings

Get Sign In Settings for the Portal.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

Returns

PortalSigninSettings or the result of cls(response)

Return type

PortalSigninSettings

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, **kwargs: Any) → bool

Gets the entity state (Etag) version of the SignInSettings.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, if_match: str, parameters: _models.PortalSigninSettings, *, content_type: str = "'application/json'", **kwargs: Any) → None

update(resource_group_name: str, service_name: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → None

Update Sign-In settings.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• parameters (PortalSigninSettings or IO) – Update Sign-In settings. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.SignUpSettingsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s sign_up_settings attribute.

create_or_update(resource_group_name: str, service_name: str, parameters: _models.PortalSignupSettings, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PortalSignupSettings

create_or_update(resource_group_name: str, service_name: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.PortalSignupSettings

Create or Update Sign-Up settings.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• parameters (PortalSignupSettings or IO) – Create or update parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

PortalSignupSettings or the result of cls(response)

Return type

PortalSignupSettings

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.PortalSignupSettings

Get Sign Up Settings for the Portal.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

Returns

PortalSignupSettings or the result of cls(response)

Return type

PortalSignupSettings

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, **kwargs: Any) → bool

Gets the entity state (Etag) version of the SignUpSettings.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, if_match: str, parameters: _models.PortalSignupSettings, *, content_type: str = "'application/json'", **kwargs: Any) → None

update(resource_group_name: str, service_name: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → None

Update Sign-Up settings.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• parameters (PortalSignupSettings or IO) – Update Sign-Up settings. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.SubscriptionOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s subscription attribute.

create_or_update(resource_group_name: str, service_name: str, sid: str, parameters: _models.SubscriptionCreateParameters, notify: Optional[bool] = None, if_match: Optional[str] = None, app_type: Optional[Union[str, _models.AppType]] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SubscriptionContract

create_or_update(resource_group_name: str, service_name: str, sid: str, parameters: IO, notify: Optional[bool] = None, if_match: Optional[str] = None, app_type: Optional[Union[str, _models.AppType]] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SubscriptionContract

Creates or updates the subscription of specified user to the specified product.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• sid (str) – Subscription entity Identifier. The entity represents the association between a user and a product in API Management. Required.

• parameters (SubscriptionCreateParameters or IO) – Create parameters. Is either a model type or a IO type. Required.

• 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. Default value is None.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

• app_type (str or AppType) – Determines the type of application which send the create user request. Default is legacy publisher portal. Known values are: “portal” and “developerPortal”. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

SubscriptionContract or the result of cls(response)

Return type

SubscriptionContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, sid: str, if_match: str, **kwargs: Any) → None

Deletes the specified subscription.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• sid (str) – Subscription entity Identifier. The entity represents the association between a user and a product in API Management. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, sid: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.SubscriptionContract

Gets the specified Subscription entity.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• sid (str) – Subscription entity Identifier. The entity represents the association between a user and a product in API Management. Required.

Keyword Arguments

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

Returns

SubscriptionContract or the result of cls(response)

Return type

SubscriptionContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, sid: str, **kwargs: Any) → bool

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. Required.

• service_name (str) – The name of the API Management service. Required.

• sid (str) – Subscription entity Identifier. The entity represents the association between a user and a product in API Management. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.SubscriptionContract]

Lists all subscriptions of the API Management service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SubscriptionContract]

Raises

HttpResponseError –

list_secrets(resource_group_name: str, service_name: str, sid: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.SubscriptionKeysContract

Gets the specified Subscription keys.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• sid (str) – Subscription entity Identifier. The entity represents the association between a user and a product in API Management. Required.

Keyword Arguments

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

Returns

SubscriptionKeysContract or the result of cls(response)

Return type

SubscriptionKeysContract

Raises

HttpResponseError –

regenerate_primary_key(resource_group_name: str, service_name: str, sid: str, **kwargs: Any) → None

Regenerates primary key of existing subscription of the API Management service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• sid (str) – Subscription entity Identifier. The entity represents the association between a user and a product in API Management. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

regenerate_secondary_key(resource_group_name: str, service_name: str, sid: str, **kwargs: Any) → None

Regenerates secondary key of existing subscription of the API Management service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• sid (str) – Subscription entity Identifier. The entity represents the association between a user and a product in API Management. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, sid: str, if_match: str, parameters: _models.SubscriptionUpdateParameters, notify: Optional[bool] = None, app_type: Optional[Union[str, _models.AppType]] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SubscriptionContract

update(resource_group_name: str, service_name: str, sid: str, if_match: str, parameters: IO, notify: Optional[bool] = None, app_type: Optional[Union[str, _models.AppType]] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.SubscriptionContract

Updates the details of a subscription specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• sid (str) – Subscription entity Identifier. The entity represents the association between a user and a product in API Management. Required.

• 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. Required.

• parameters (SubscriptionUpdateParameters or IO) – Update parameters. Is either a model type or a IO type. Required.

• 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. Default value is None.

• app_type (str or AppType) – Determines the type of application which send the create user request. Default is legacy publisher portal. Known values are: “portal” and “developerPortal”. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

SubscriptionContract or the result of cls(response)

Return type

SubscriptionContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.TagOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s tag attribute.

assign_to_api(resource_group_name: str, service_name: str, api_id: str, tag_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.TagContract

Assign tag to the Api.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• tag_id (str) – Tag identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

TagContract or the result of cls(response)

Return type

TagContract

Raises

HttpResponseError –

assign_to_operation(resource_group_name: str, service_name: str, api_id: str, operation_id: str, tag_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.TagContract

Assign tag to the Operation.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance. Required.

• tag_id (str) – Tag identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

TagContract or the result of cls(response)

Return type

TagContract

Raises

HttpResponseError –

assign_to_product(resource_group_name: str, service_name: str, product_id: str, tag_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.TagContract

Assign tag to the Product.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• tag_id (str) – Tag identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

TagContract or the result of cls(response)

Return type

TagContract

Raises

HttpResponseError –

create_or_update(resource_group_name: str, service_name: str, tag_id: str, parameters: _models.TagCreateUpdateParameters, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TagContract

create_or_update(resource_group_name: str, service_name: str, tag_id: str, parameters: IO, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TagContract

Creates a tag.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• tag_id (str) – Tag identifier. Must be unique in the current API Management service instance. Required.

• parameters (TagCreateUpdateParameters or IO) – Create parameters. Is either a model type or a IO type. Required.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

TagContract or the result of cls(response)

Return type

TagContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, tag_id: str, if_match: str, **kwargs: Any) → None

Deletes specific tag of the API Management service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• tag_id (str) – Tag identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

detach_from_api(resource_group_name: str, service_name: str, api_id: str, tag_id: str, **kwargs: Any) → None

Detach the tag from the Api.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• tag_id (str) – Tag identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

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

Detach the tag from the Operation.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance. Required.

• tag_id (str) – Tag identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

detach_from_product(resource_group_name: str, service_name: str, product_id: str, tag_id: str, **kwargs: Any) → None

Detach the tag from the Product.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• tag_id (str) – Tag identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, tag_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.TagContract

Gets the details of the tag specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• tag_id (str) – Tag identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

TagContract or the result of cls(response)

Return type

TagContract

Raises

HttpResponseError –

get_by_api(resource_group_name: str, service_name: str, api_id: str, tag_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.TagContract

Get tag associated with the API.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• tag_id (str) – Tag identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

TagContract or the result of cls(response)

Return type

TagContract

Raises

HttpResponseError –

get_by_operation(resource_group_name: str, service_name: str, api_id: str, operation_id: str, tag_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.TagContract

Get tag associated with the Operation.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance. Required.

• tag_id (str) – Tag identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

TagContract or the result of cls(response)

Return type

TagContract

Raises

HttpResponseError –

get_by_product(resource_group_name: str, service_name: str, product_id: str, tag_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.TagContract

Get tag associated with the Product.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• tag_id (str) – Tag identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

TagContract or the result of cls(response)

Return type

TagContract

Raises

HttpResponseError –

get_entity_state(resource_group_name: str, service_name: str, tag_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• tag_id (str) – Tag identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

get_entity_state_by_api(resource_group_name: str, service_name: str, api_id: str, tag_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• tag_id (str) – Tag identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

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

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance. Required.

• tag_id (str) – Tag identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

get_entity_state_by_product(resource_group_name: str, service_name: str, product_id: str, tag_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• tag_id (str) – Tag identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_api(resource_group_name: str, service_name: str, api_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.TagContract]

Lists all Tags associated with the API.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[TagContract]

Raises

HttpResponseError –

list_by_operation(resource_group_name: str, service_name: str, api_id: str, operation_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.TagContract]

Lists all Tags associated with the Operation.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• 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. Required.

• operation_id (str) – Operation identifier within an API. Must be unique in the current API Management service instance. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[TagContract]

Raises

HttpResponseError –

list_by_product(resource_group_name: str, service_name: str, product_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.TagContract]

Lists all Tags associated with the Product.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• product_id (str) – Product identifier. Must be unique in the current API Management service instance. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[TagContract]

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, scope: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.TagContract]

Lists a collection of tags defined within a service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

• scope (str) – Scope like ‘apis’, ‘products’ or ‘apis/{apiId}. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[TagContract]

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, tag_id: str, if_match: str, parameters: _models.TagCreateUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TagContract

update(resource_group_name: str, service_name: str, tag_id: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.TagContract

Updates the details of the tag specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• tag_id (str) – Tag identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

• parameters (TagCreateUpdateParameters or IO) – Update parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

TagContract or the result of cls(response)

Return type

TagContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.TagResourceOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s tag_resource attribute.

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.TagResourceContract]

Lists a collection of resources associated with tags.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[TagResourceContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.TenantAccessGitOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s tenant_access_git attribute.

regenerate_primary_key(resource_group_name: str, service_name: str, access_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.AccessIdName], **kwargs: Any) → None

Regenerate primary access key for GIT.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• access_name (str or AccessIdName) – The identifier of the Access configuration. Known values are: “access” and “gitAccess”. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

regenerate_secondary_key(resource_group_name: str, service_name: str, access_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.AccessIdName], **kwargs: Any) → None

Regenerate secondary access key for GIT.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• access_name (str or AccessIdName) – The identifier of the Access configuration. Known values are: “access” and “gitAccess”. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.TenantAccessOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s tenant_access attribute.

create(resource_group_name: str, service_name: str, access_name: Union[str, _models.AccessIdName], if_match: str, parameters: _models.AccessInformationCreateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessInformationContract

create(resource_group_name: str, service_name: str, access_name: Union[str, _models.AccessIdName], if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessInformationContract

Update tenant access information details.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• access_name (str or AccessIdName) – The identifier of the Access configuration. Known values are: “access” and “gitAccess”. Required.

• 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. Required.

• parameters (AccessInformationCreateParameters or IO) – Parameters supplied to retrieve the Tenant Access Information. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

AccessInformationContract or the result of cls(response)

Return type

AccessInformationContract

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, access_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.AccessIdName], **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.AccessInformationContract

Get tenant access information details without secrets.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• access_name (str or AccessIdName) – The identifier of the Access configuration. Known values are: “access” and “gitAccess”. Required.

Keyword Arguments

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

Returns

AccessInformationContract or the result of cls(response)

Return type

AccessInformationContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, access_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.AccessIdName], **kwargs: Any) → bool

Tenant access metadata.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• access_name (str or AccessIdName) – The identifier of the Access configuration. Known values are: “access” and “gitAccess”. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.AccessInformationContract]

Returns list of access infos - for Git and Management endpoints.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) – Not used. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[AccessInformationContract]

Raises

HttpResponseError –

list_secrets(resource_group_name: str, service_name: str, access_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.AccessIdName], **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.AccessInformationSecretsContract

Get tenant access information details.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• access_name (str or AccessIdName) – The identifier of the Access configuration. Known values are: “access” and “gitAccess”. Required.

Keyword Arguments

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

Returns

AccessInformationSecretsContract or the result of cls(response)

Return type

AccessInformationSecretsContract

Raises

HttpResponseError –

regenerate_primary_key(resource_group_name: str, service_name: str, access_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.AccessIdName], **kwargs: Any) → None

Regenerate primary access key.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• access_name (str or AccessIdName) – The identifier of the Access configuration. Known values are: “access” and “gitAccess”. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

regenerate_secondary_key(resource_group_name: str, service_name: str, access_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.AccessIdName], **kwargs: Any) → None

Regenerate secondary access key.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• access_name (str or AccessIdName) – The identifier of the Access configuration. Known values are: “access” and “gitAccess”. Required.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, access_name: Union[str, _models.AccessIdName], if_match: str, parameters: _models.AccessInformationUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessInformationContract

update(resource_group_name: str, service_name: str, access_name: Union[str, _models.AccessIdName], if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.AccessInformationContract

Update tenant access information details.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• access_name (str or AccessIdName) – The identifier of the Access configuration. Known values are: “access” and “gitAccess”. Required.

• 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. Required.

• parameters (AccessInformationUpdateParameters or IO) – Parameters supplied to retrieve the Tenant Access Information. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

AccessInformationContract or the result of cls(response)

Return type

AccessInformationContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.TenantConfigurationOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s tenant_configuration attribute.

begin_deploy(resource_group_name: str, service_name: str, configuration_name: Union[str, _models.ConfigurationIdName], parameters: _models.DeployConfigurationParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.OperationResultContract]

begin_deploy(resource_group_name: str, service_name: str, configuration_name: Union[str, _models.ConfigurationIdName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.OperationResultContract]

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. Required.

• service_name (str) – The name of the API Management service. Required.

• configuration_name (str or ConfigurationIdName) – The identifier of the Git Configuration Operation. “configuration” Required.

• parameters (DeployConfigurationParameters or IO) – Deploy Configuration parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[OperationResultContract]

Raises

HttpResponseError –

begin_save(resource_group_name: str, service_name: str, configuration_name: Union[str, _models.ConfigurationIdName], parameters: _models.SaveConfigurationParameter, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.OperationResultContract]

begin_save(resource_group_name: str, service_name: str, configuration_name: Union[str, _models.ConfigurationIdName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.OperationResultContract]

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. Required.

• service_name (str) – The name of the API Management service. Required.

• configuration_name (str or ConfigurationIdName) – The identifier of the Git Configuration Operation. “configuration” Required.

• parameters (SaveConfigurationParameter or IO) – Save Configuration parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[OperationResultContract]

Raises

HttpResponseError –

begin_validate(resource_group_name: str, service_name: str, configuration_name: Union[str, _models.ConfigurationIdName], parameters: _models.DeployConfigurationParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.OperationResultContract]

begin_validate(resource_group_name: str, service_name: str, configuration_name: Union[str, _models.ConfigurationIdName], parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.OperationResultContract]

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. Required.

• service_name (str) – The name of the API Management service. Required.

• configuration_name (str or ConfigurationIdName) – The identifier of the Git Configuration Operation. “configuration” Required.

• parameters (DeployConfigurationParameters or IO) – Validate Configuration parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

• continuation_token (str) – A continuation token to restart a poller from a saved state.

• polling (bool or PollingMethod) – By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.

• polling_interval (int) – Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

LROPoller[OperationResultContract]

Raises

HttpResponseError –

get_sync_state(resource_group_name: str, service_name: str, configuration_name: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.ConfigurationIdName], **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.TenantConfigurationSyncStateContract

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. Required.

• service_name (str) – The name of the API Management service. Required.

• configuration_name (str or ConfigurationIdName) – The identifier of the Git Configuration Operation. “configuration” Required.

Keyword Arguments

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

Returns

TenantConfigurationSyncStateContract or the result of cls(response)

Return type

TenantConfigurationSyncStateContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.TenantSettingsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s tenant_settings attribute.

get(resource_group_name: str, service_name: str, settings_type: Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.SettingsTypeName], **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.TenantSettingsContract

Get tenant settings.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• settings_type (str or SettingsTypeName) – The identifier of the settings. “public” Required.

Keyword Arguments

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

Returns

TenantSettingsContract or the result of cls(response)

Return type

TenantSettingsContract

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.TenantSettingsContract]

Public settings.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) – Not used. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[TenantSettingsContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.UserConfirmationPasswordOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s user_confirmation_password attribute.

send(resource_group_name: str, service_name: str, user_id: str, app_type: Optional[Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.AppType]] = None, **kwargs: Any) → None

Sends confirmation.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• user_id (str) – User identifier. Must be unique in the current API Management service instance. Required.

• app_type (str or AppType) – Determines the type of application which send the create user request. Default is legacy publisher portal. Known values are: “portal” and “developerPortal”. Default value is None.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.UserGroupOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s user_group attribute.

list(resource_group_name: str, service_name: str, user_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.GroupContract]

Lists all user groups.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• user_id (str) – User identifier. Must be unique in the current API Management service instance. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[GroupContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.UserIdentitiesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s user_identities attribute.

list(resource_group_name: str, service_name: str, user_id: str, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.UserIdentityContract]

List of all user identities.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• user_id (str) – User identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[UserIdentityContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.UserOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s user attribute.

create_or_update(resource_group_name: str, service_name: str, user_id: str, parameters: _models.UserCreateParameters, notify: Optional[bool] = None, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.UserContract

create_or_update(resource_group_name: str, service_name: str, user_id: str, parameters: IO, notify: Optional[bool] = None, if_match: Optional[str] = None, *, content_type: str = "'application/json'", **kwargs: Any) → _models.UserContract

Creates or Updates a user.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• user_id (str) – User identifier. Must be unique in the current API Management service instance. Required.

• parameters (UserCreateParameters or IO) – Create or update parameters. Is either a model type or a IO type. Required.

• notify (bool) – Send an Email notification to the User. Default value is None.

• if_match (str) – ETag of the Entity. Not required when creating an entity, but required when updating an entity. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

UserContract or the result of cls(response)

Return type

UserContract

Raises

HttpResponseError –

delete(resource_group_name: str, service_name: str, user_id: str, if_match: str, delete_subscriptions: Optional[bool] = None, notify: Optional[bool] = None, app_type: Optional[Union[str, azure.mgmt.apimanagement.models._api_management_client_enums.AppType]] = None, **kwargs: Any) → None

Deletes specific user.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• user_id (str) – User identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

• delete_subscriptions (bool) – Whether to delete user’s subscription or not. Default value is None.

• notify (bool) – Send an Account Closed Email notification to the User. Default value is None.

• app_type (str or AppType) – Determines the type of application which send the create user request. Default is legacy publisher portal. Known values are: “portal” and “developerPortal”. Default value is None.

Keyword Arguments

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

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

generate_sso_url(resource_group_name: str, service_name: str, user_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.GenerateSsoUrlResult

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. Required.

• service_name (str) – The name of the API Management service. Required.

• user_id (str) – User identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

GenerateSsoUrlResult or the result of cls(response)

Return type

GenerateSsoUrlResult

Raises

HttpResponseError –

get(resource_group_name: str, service_name: str, user_id: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.UserContract

Gets the details of the user specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• user_id (str) – User identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

UserContract or the result of cls(response)

Return type

UserContract

Raises

HttpResponseError –

get_entity_tag(resource_group_name: str, service_name: str, user_id: str, **kwargs: Any) → bool

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

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• user_id (str) – User identifier. Must be unique in the current API Management service instance. Required.

Keyword Arguments

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

Returns

bool or the result of cls(response)

Return type

bool

Raises

HttpResponseError –

get_shared_access_token(resource_group_name: str, service_name: str, user_id: str, parameters: _models.UserTokenParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.UserTokenResult

get_shared_access_token(resource_group_name: str, service_name: str, user_id: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.UserTokenResult

Gets the Shared Access Authorization Token for the User.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• user_id (str) – User identifier. Must be unique in the current API Management service instance. Required.

• parameters (UserTokenParameters or IO) – Create Authorization Token parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

UserTokenResult or the result of cls(response)

Return type

UserTokenResult

Raises

HttpResponseError –

list_by_service(resource_group_name: str, service_name: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, expand_groups: Optional[bool] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.UserContract]

Lists a collection of registered users in the specified service instance.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported

  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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

• expand_groups (bool) – Detailed Group in response. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[UserContract]

Raises

HttpResponseError –

update(resource_group_name: str, service_name: str, user_id: str, if_match: str, parameters: _models.UserUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → _models.UserContract

update(resource_group_name: str, service_name: str, user_id: str, if_match: str, parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.UserContract

Updates the details of the user specified by its identifier.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• user_id (str) – User identifier. Must be unique in the current API Management service instance. Required.

• 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. Required.

• parameters (UserUpdateParameters or IO) – Update parameters. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

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

Returns

UserContract or the result of cls(response)

Return type

UserContract

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>

class azure.mgmt.apimanagement.operations.UserSubscriptionOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ApiManagementClient’s user_subscription attribute.

get(resource_group_name: str, service_name: str, user_id: str, sid: str, **kwargs: Any) → azure.mgmt.apimanagement.models._models_py3.SubscriptionContract

Gets the specified Subscription entity associated with a particular user.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• user_id (str) – User identifier. Must be unique in the current API Management service instance. Required.

• sid (str) – Subscription entity Identifier. The entity represents the association between a user and a product in API Management. Required.

Keyword Arguments

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

Returns

SubscriptionContract or the result of cls(response)

Return type

SubscriptionContract

Raises

HttpResponseError –

list(resource_group_name: str, service_name: str, user_id: str, filter: Optional[str] = None, top: Optional[int] = None, skip: Optional[int] = None, **kwargs: Any) → Iterable[azure.mgmt.apimanagement.models._models_py3.SubscriptionContract]

Lists the collection of subscriptions of the specified user.

Parameters

• resource_group_name (str) – The name of the resource group. Required.

• service_name (str) – The name of the API Management service. Required.

• user_id (str) – User identifier. Must be unique in the current API Management service instance. Required.

• filter (str) –

  Field | Usage | Supported operators | Supported 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>. Default value is None.

• top (int) – Number of records to return. Default value is None.

• skip (int) – Number of records to skip. Default value is None.

Keyword Arguments

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

Returns

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

Return type

ItemPaged[SubscriptionContract]

Raises

HttpResponseError –

models = <module 'azure.mgmt.apimanagement.models' from '/mnt/vss/_work/1/s/sdk/apimanagement/azure-mgmt-apimanagement/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/apimanagement/models/__init__.py'>