Try SpotterManage Azure ApiOperation instance.
| "added in version" 2.9 of azure.rm"
Authors: Zim Kalinowski (@zikalino)
preview | supported by community
Install with ansible-galaxy collection install azure.rm:==0.0.6
collections:
- name: azure.rm
version: 0.0.6Create, update and delete instance of Azure ApiOperation.
- name: ApiManagementCreateApiOperation
azure.rm.apimanagementapioperation:
resource_group: myResourceGroup
service_name: myService
api_id: myApi
operation_id: myOperation
template_parameters: []
description: This can only be done by the logged in user.
request:
description: Created user object
query_parameters: []
headers: []
representations:
- content_type: application/json
schema_id: 592f6c1d0af5840ca8897f0c
type_name: User
responses:
- status_code: '200'
description: successful operation
representations:
- content_type: application/xml
- content_type: application/json
headers: []
display_name: createUser2
method: POST
url_template: /user1
- name: ApiManagementUpdateApiOperation
azure.rm.apimanagementapioperation:
resource_group: myResourceGroup
service_name: myService
api_id: myApi
operation_id: myOperation
template_parameters: []
request:
query_parameters:
- name: param1
description: >-
A sample parameter that is required and has a default value of
"sample".
type: string
default_value: sample
required: true
values:
- sample
responses:
- status_code: '200'
description: Returned in all cases.
representations: []
headers: []
- status_code: '500'
description: Server Error.
representations: []
headers: []
display_name: Retrieve resource
method: GET
url_template: /resource
- name: ApiManagementDeleteApiOperation
azure.rm.apimanagementapioperation:
resource_group: myResourceGroup
service_name: myService
api_id: myApi
operation_id: myOperation
state: absent
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the ApiOperation.
- Use C(present) to create or update an ApiOperation and C(absent) to delete it.
api_id:
description:
- 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: true
type: str
method:
description:
- A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not
limited by only them.
required: true
type: str
secret:
description:
- Azure client secret. Use when authenticating with a Service Principal.
type: str
tenant:
description:
- Azure tenant ID. Use when authenticating with a Service Principal.
type: str
ad_user:
description:
- Active Directory username. Use when authenticating with an Active Directory user
rather than service principal.
type: str
profile:
description:
- Security profile found in ~/.azure/credentials file.
type: str
request:
description:
- An entity containing request details.
suboptions:
description:
description:
- Operation request description.
type: str
headers:
description:
- Collection of operation request headers.
suboptions:
default_value:
description:
- Default parameter value.
type: str
description:
description:
- Parameter description.
type: str
name:
description:
- Parameter name.
required: true
type: str
required:
description:
- Specifies whether parameter is required or not.
type: boolean
type:
description:
- Parameter type.
required: true
type: str
values:
description:
- Parameter values.
type: list
type: list
query_parameters:
description:
- Collection of operation request query parameters.
suboptions:
default_value:
description:
- Default parameter value.
type: str
description:
description:
- Parameter description.
type: str
name:
description:
- Parameter name.
required: true
type: str
required:
description:
- Specifies whether parameter is required or not.
type: boolean
type:
description:
- Parameter type.
required: true
type: str
values:
description:
- Parameter values.
type: list
type: list
representations:
description:
- Collection of operation request representations.
suboptions:
content_type:
description:
- Specifies a registered or custom content type for this representation, e.g.
application/xml.
required: true
type: str
form_parameters:
description:
- Collection of form parameters. Required if 'contentType' value is either
'application/x-www-form-urlencoded' or 'multipart/form-data'..
suboptions:
default_value:
description:
- Default parameter value.
type: str
description:
description:
- Parameter description.
type: str
name:
description:
- Parameter name.
required: true
type: str
required:
description:
- Specifies whether parameter is required or not.
type: boolean
type:
description:
- Parameter type.
required: true
type: str
values:
description:
- Parameter values.
type: list
type: list
sample:
description:
- An example of the representation.
type: str
schema_id:
description:
- Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded'
nor 'multipart/form-data'.
type: str
type_name:
description:
- Type name defined by the schema. Applicable only if 'contentType' value
is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
type: str
type: list
type: dict
log_mode:
description:
- Parent argument.
type: str
log_path:
description:
- Parent argument.
type: str
password:
description:
- Active Directory user password. Use when authenticating with an Active Directory
user rather than service principal.
type: str
policies:
description:
- Operation Policies
type: str
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal.
type: str
responses:
description:
- Array of Operation responses.
suboptions:
description:
description:
- Operation response description.
type: str
headers:
description:
- Collection of operation response headers.
suboptions:
default_value:
description:
- Default parameter value.
type: str
description:
description:
- Parameter description.
type: str
name:
description:
- Parameter name.
required: true
type: str
required:
description:
- Specifies whether parameter is required or not.
type: boolean
type:
description:
- Parameter type.
required: true
type: str
values:
description:
- Parameter values.
type: list
type: list
representations:
description:
- Collection of operation response representations.
suboptions:
content_type:
description:
- Specifies a registered or custom content type for this representation, e.g.
application/xml.
required: true
type: str
form_parameters:
description:
- Collection of form parameters. Required if 'contentType' value is either
'application/x-www-form-urlencoded' or 'multipart/form-data'..
suboptions:
default_value:
description:
- Default parameter value.
type: str
description:
description:
- Parameter description.
type: str
name:
description:
- Parameter name.
required: true
type: str
required:
description:
- Specifies whether parameter is required or not.
type: boolean
type:
description:
- Parameter type.
required: true
type: str
values:
description:
- Parameter values.
type: list
type: list
sample:
description:
- An example of the representation.
type: str
schema_id:
description:
- Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded'
nor 'multipart/form-data'.
type: str
type_name:
description:
- Type name defined by the schema. Applicable only if 'contentType' value
is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
type: str
type: list
status_code:
description:
- Operation response HTTP status code.
required: true
type: number
type: list
api_profile:
default: latest
description:
- Selects an API profile to use when communicating with Azure services. Default value
of C(latest) is appropriate for public clouds; future values will allow use with
Azure Stack.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
auth_source:
choices:
- auto
- cli
- credential_file
- env
- msi
default: auto
description:
- Controls the source of the credentials to use for authentication.
- Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable.
- When set to C(auto) (the default) the precedence is module parameters -> C(env)
-> C(credential_file) -> C(cli).
- When set to C(env), the credentials will be read from the environment variables
- When set to C(credential_file), it will read the profile from C(~/.azure/credentials).
- When set to C(cli), the credentials will be sources from the Azure CLI profile.
C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID) can be used
to identify the subscription ID if more than one is present otherwise the default
az cli subscription is used.
- When set to C(msi), the host machine must be an azure resource with an enabled MSI
extension. C(subscription_id) or the environment variable C(AZURE_SUBSCRIPTION_ID)
can be used to identify the subscription ID if the resource is granted access to
more than one subscription, otherwise the first subscription is chosen.
- The C(msi) was added in Ansible 2.6.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
description:
description:
- Description of the operation. May include HTML formatting tags.
type: str
display_name:
description:
- Operation Name.
required: true
type: str
operation_id:
description:
- Operation identifier within an API. Must be unique in the current API Management
service instance.
required: true
type: str
service_name:
description:
- The name of the API Management service.
required: true
type: str
url_template:
description:
- 'Relative URL template identifying the target resource for this operation. May include
parameters. Example: /customers/{cid}/orders/{oid}/?date={date}'
required: true
type: str
resource_group:
description:
- The name of the resource group.
required: true
type: str
subscription_id:
description:
- Your Azure subscription Id.
type: str
cloud_environment:
default: AzureCloud
description:
- For cloud environments other than the US public cloud, the environment name (as
defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a
metadata discovery endpoint URL (required for Azure Stack). Can also be set via
credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
adfs_authority_url:
description:
- Azure AD authority url. Use when authenticating with Username/password, and has
your own ADFS authority.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
template_parameters:
description:
- Collection of URL template parameters.
suboptions:
default_value:
description:
- Default parameter value.
type: str
description:
description:
- Parameter description.
type: str
name:
description:
- Parameter name.
required: true
type: str
required:
description:
- Specifies whether parameter is required or not.
type: boolean
type:
description:
- Parameter type.
required: true
type: str
values:
description:
- Parameter values.
type: list
type: list
cert_validation_mode:
choices:
- ignore
- validate
description:
- Controls the certificate validation behavior for Azure endpoints. By default, all
modules will validate the server certificate, but when an HTTPS proxy is in use,
or against Azure Stack, it may be necessary to disable this behavior by passing
C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION)
environment variable.
type: str
version_added: 0.0.1
version_added_collection: azure.azcollection
id:
description:
- Resource ID.
returned: always
sample: null
type: str
name:
description:
- Resource name.
returned: always
sample: null
type: str
properties:
contains:
description:
description:
- Description of the operation. May include HTML formatting tags.
returned: always
sample: null
type: str
display_name:
description:
- Operation Name.
returned: always
sample: null
type: str
method:
description:
- A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but
not limited by only them.
returned: always
sample: null
type: str
policies:
description:
- Operation Policies
returned: always
sample: null
type: str
request:
contains:
description:
description:
- Operation request description.
returned: always
sample: null
type: str
headers:
contains:
default_value:
description:
- Default parameter value.
returned: always
sample: null
type: str
description:
description:
- Parameter description.
returned: always
sample: null
type: str
name:
description:
- Parameter name.
returned: always
sample: null
type: str
required:
description:
- Specifies whether parameter is required or not.
returned: always
sample: null
type: boolean
type:
description:
- Parameter type.
returned: always
sample: null
type: str
values:
description:
- Parameter values.
returned: always
sample: null
type: str
description:
- Collection of operation request headers.
returned: always
sample: null
type: dict
query_parameters:
contains:
default_value:
description:
- Default parameter value.
returned: always
sample: null
type: str
description:
description:
- Parameter description.
returned: always
sample: null
type: str
name:
description:
- Parameter name.
returned: always
sample: null
type: str
required:
description:
- Specifies whether parameter is required or not.
returned: always
sample: null
type: boolean
type:
description:
- Parameter type.
returned: always
sample: null
type: str
values:
description:
- Parameter values.
returned: always
sample: null
type: str
description:
- Collection of operation request query parameters.
returned: always
sample: null
type: dict
representations:
contains:
content_type:
description:
- Specifies a registered or custom content type for this representation,
e.g. application/xml.
returned: always
sample: null
type: str
form_parameters:
contains:
default_value:
description:
- Default parameter value.
returned: always
sample: null
type: str
description:
description:
- Parameter description.
returned: always
sample: null
type: str
name:
description:
- Parameter name.
returned: always
sample: null
type: str
required:
description:
- Specifies whether parameter is required or not.
returned: always
sample: null
type: boolean
type:
description:
- Parameter type.
returned: always
sample: null
type: str
values:
description:
- Parameter values.
returned: always
sample: null
type: str
description:
- Collection of form parameters. Required if 'contentType' value is
either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
returned: always
sample: null
type: dict
sample:
description:
- An example of the representation.
returned: always
sample: null
type: str
schema_id:
description:
- Schema identifier. Applicable only if 'contentType' value is neither
'application/x-www-form-urlencoded' nor 'multipart/form-data'.
returned: always
sample: null
type: str
type_name:
description:
- Type name defined by the schema. Applicable only if 'contentType'
value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
returned: always
sample: null
type: str
description:
- Collection of operation request representations.
returned: always
sample: null
type: dict
description:
- An entity containing request details.
returned: always
sample: null
type: dict
responses:
contains:
description:
description:
- Operation response description.
returned: always
sample: null
type: str
headers:
contains:
default_value:
description:
- Default parameter value.
returned: always
sample: null
type: str
description:
description:
- Parameter description.
returned: always
sample: null
type: str
name:
description:
- Parameter name.
returned: always
sample: null
type: str
required:
description:
- Specifies whether parameter is required or not.
returned: always
sample: null
type: boolean
type:
description:
- Parameter type.
returned: always
sample: null
type: str
values:
description:
- Parameter values.
returned: always
sample: null
type: str
description:
- Collection of operation response headers.
returned: always
sample: null
type: dict
representations:
contains:
content_type:
description:
- Specifies a registered or custom content type for this representation,
e.g. application/xml.
returned: always
sample: null
type: str
form_parameters:
contains:
default_value:
description:
- Default parameter value.
returned: always
sample: null
type: str
description:
description:
- Parameter description.
returned: always
sample: null
type: str
name:
description:
- Parameter name.
returned: always
sample: null
type: str
required:
description:
- Specifies whether parameter is required or not.
returned: always
sample: null
type: boolean
type:
description:
- Parameter type.
returned: always
sample: null
type: str
values:
description:
- Parameter values.
returned: always
sample: null
type: str
description:
- Collection of form parameters. Required if 'contentType' value is
either 'application/x-www-form-urlencoded' or 'multipart/form-data'..
returned: always
sample: null
type: dict
sample:
description:
- An example of the representation.
returned: always
sample: null
type: str
schema_id:
description:
- Schema identifier. Applicable only if 'contentType' value is neither
'application/x-www-form-urlencoded' nor 'multipart/form-data'.
returned: always
sample: null
type: str
type_name:
description:
- Type name defined by the schema. Applicable only if 'contentType'
value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.
returned: always
sample: null
type: str
description:
- Collection of operation response representations.
returned: always
sample: null
type: dict
status_code:
description:
- Operation response HTTP status code.
returned: always
sample: null
type: number
description:
- Array of Operation responses.
returned: always
sample: null
type: dict
template_parameters:
contains:
default_value:
description:
- Default parameter value.
returned: always
sample: null
type: str
description:
description:
- Parameter description.
returned: always
sample: null
type: str
name:
description:
- Parameter name.
returned: always
sample: null
type: str
required:
description:
- Specifies whether parameter is required or not.
returned: always
sample: null
type: boolean
type:
description:
- Parameter type.
returned: always
sample: null
type: str
values:
description:
- Parameter values.
returned: always
sample: null
type: str
description:
- Collection of URL template parameters.
returned: always
sample: null
type: dict
url_template:
description:
- 'Relative URL template identifying the target resource for this operation.
May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}'
returned: always
sample: null
type: str
description:
- Properties of the Operation Contract.
returned: always
sample: null
type: dict
type:
description:
- Resource type for API Management resource.
returned: always
sample: null
type: str