Try SpotterManage Azure Subscription 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 Subscription.
- name: ApiManagementCreateSubscription
azure.rm.apimanagementsubscription:
resource_group: myResourceGroup
service_name: myService
sid: testsub
owner_id: >-
/subscriptions/{{ subscription_id }}/resourceGroups/{{ resource_group
}}/providers/Microsoft.ApiManagement/service/{{ service_name }}/users/{{
user_name }}
scope: >-
/subscriptions/{{ subscription_id }}/resourceGroups/{{ resource_group
}}/providers/Microsoft.ApiManagement/service/{{ service_name
}}/products/{{ product_name }}
display_name: testsub
- name: ApiManagementUpdateSubscription
azure.rm.apimanagementsubscription:
resource_group: myResourceGroup
service_name: myService
sid: testsub
display_name: testsub
- name: ApiManagementDeleteSubscription
azure.rm.apimanagementsubscription:
resource_group: myResourceGroup
service_name: myService
sid: testsub
state: absent
sid:
description:
- Subscription entity Identifier. The entity represents the association between a
user and a product in API Management.
required: true
type: str
scope:
description:
- Scope like /products/{productId} or /apis or /apis/{apiId}.
required: true
type: str
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the Subscription.
- Use C(present) to create or update an Subscription and C(absent) to delete it.
notify:
description:
- 'Notify change in Subscription State. <br> - If false, do not send any email notification
for change of state of subscription <br> - If true, send email notification of change
of state of subscription '
type: boolean
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
end_date:
description:
- 'Date when subscription was cancelled or expired. The setting is for audit purposes
only and the subscription is not automatically cancelled. The subscription lifecycle
can be managed by using the `state` property. The date conforms to the following
format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.<br>'
type: datetime
log_mode:
description:
- Parent argument.
type: str
log_path:
description:
- Parent argument.
type: str
owner_id:
description:
- User (user id path) for whom subscription is being created in form /users/{userId}
type: str
password:
description:
- Active Directory user password. Use when authenticating with an Active Directory
user rather than service principal.
type: str
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal.
type: str
start_date:
description:
- 'Subscription activation date. The setting is for audit purposes only and the subscription
is not automatically activated. The subscription lifecycle can be managed by using
the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ`
as specified by the ISO 8601 standard.<br>'
type: datetime
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
primary_key:
description:
- Primary subscription key. If not specified during request key will be generated
automatically.
type: str
created_date:
description:
- 'Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ`
as specified by the ISO 8601 standard.<br>'
type: datetime
display_name:
description:
- Subscription name.
required: true
type: str
service_name:
description:
- The name of the API Management service.
required: true
type: str
allow_tracing:
description:
- Determines whether tracing can be enabled
type: boolean
secondary_key:
description:
- Secondary subscription key. If not specified during request key will be generated
automatically.
type: str
state_comment:
description:
- Optional subscription comment added by an administrator.
type: str
resource_group:
description:
- The name of the resource group.
required: true
type: str
expiration_date:
description:
- 'Subscription expiration date. The setting is for audit purposes only and the subscription
is not automatically expired. The subscription lifecycle can be managed by using
the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ`
as specified by the ISO 8601 standard.<br>'
type: datetime
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
notification_date:
description:
- 'Upcoming subscription expiration notification date. The date conforms to the following
format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.<br>'
type: datetime
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
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:
allow_tracing:
description:
- Determines whether tracing is enabled
returned: always
sample: null
type: boolean
created_date:
description:
- 'Subscription creation date. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ`
as specified by the ISO 8601 standard.<br>'
returned: always
sample: null
type: datetime
display_name:
description:
- The name of the subscription, or null if the subscription has no name.
returned: always
sample: null
type: str
end_date:
description:
- 'Date when subscription was cancelled or expired. The setting is for audit
purposes only and the subscription is not automatically cancelled. The subscription
lifecycle can be managed by using the `state` property. The date conforms
to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601
standard.<br>'
returned: always
sample: null
type: datetime
expiration_date:
description:
- 'Subscription expiration date. The setting is for audit purposes only and
the subscription is not automatically expired. The subscription lifecycle
can be managed by using the `state` property. The date conforms to the following
format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.<br>'
returned: always
sample: null
type: datetime
notification_date:
description:
- 'Upcoming subscription expiration notification date. The date conforms to
the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601
standard.<br>'
returned: always
sample: null
type: datetime
owner_id:
description:
- The user resource identifier of the subscription owner. The value is a valid
relative URL in the format of /users/{userId} where {userId} is a user identifier.
returned: always
sample: null
type: str
primary_key:
description:
- Subscription primary key.
returned: always
sample: null
type: str
scope:
description:
- Scope like /products/{productId} or /apis or /apis/{apiId}.
returned: always
sample: null
type: str
secondary_key:
description:
- Subscription secondary key.
returned: always
sample: null
type: str
start_date:
description:
- 'Subscription activation date. The setting is for audit purposes only and
the subscription is not automatically activated. The subscription lifecycle
can be managed by using the `state` property. The date conforms to the following
format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard.<br>'
returned: always
sample: null
type: datetime
state:
description:
- "Subscription state. Possible states are * active \u2013 the subscription\
\ is active, * suspended \u2013 the subscription is blocked, and the subscriber\
\ cannot call any APIs of the product, * submitted \u2013 the subscription\
\ request has been made by the developer, but has not yet been approved or\
\ rejected, * rejected \u2013 the subscription request has been denied by\
\ an administrator, * cancelled \u2013 the subscription has been cancelled\
\ by the developer or administrator, * expired \u2013 the subscription reached\
\ its expiration date and was deactivated."
returned: always
sample: null
type: str
state_comment:
description:
- Optional subscription comment added by an administrator.
returned: always
sample: null
type: str
description:
- Subscription contract properties.
returned: always
sample: null
type: dict
type:
description:
- Resource type for API Management resource.
returned: always
sample: null
type: str