azure.mgmt.appconfiguration.models module¶

class azure.mgmt.appconfiguration.models.ActionsRequired(value)[source]¶

Bases: str, enum.Enum

Any action that is required beyond basic workflow (approve/ reject/ disconnect)

none = 'None'¶

recreate = 'Recreate'¶

class azure.mgmt.appconfiguration.models.ApiKey(**kwargs)[source]¶

Bases: msrest.serialization.Model

An API key used for authenticating with a configuration store endpoint.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The key ID.
name (str) – A name for the key describing its usage.
value (str) – The value of the key that is used for authentication purposes.
connection_string (str) – A connection string that can be used by supporting clients for authentication.
last_modified (datetime) – The last time any of the key’s properties were modified.
read_only (bool) – Whether this key can only be used for read operations.

class azure.mgmt.appconfiguration.models.ApiKeyListResult(*, value: Optional[List[ApiKey]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The result of a request to list API keys.

Parameters

value (list[ApiKey]) – The collection value.
next_link (str) – The URI that can be used to request the next set of paged results.

class azure.mgmt.appconfiguration.models.CheckNameAvailabilityParameters(*, name: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Parameters used for checking whether a resource name is available.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Parameters: name (str) – Required. The name to check for availability.
Variables: type (str) – Required. The resource type to check for name availability. Default value: “Microsoft.AppConfiguration/configurationStores”.

type = 'Microsoft.AppConfiguration/configurationStores'¶

class azure.mgmt.appconfiguration.models.ConfigurationStore(*, location: str, sku: azure.mgmt.appconfiguration.models._models_py3.Sku, tags: Optional[Dict[str, str]] = None, identity: Optional[ResourceIdentity] = None, encryption: Optional[EncryptionProperties] = None, public_network_access: Optional[Union[str, PublicNetworkAccess]] = None, **kwargs)[source]¶

Bases: azure.mgmt.appconfiguration.models._models_py3.Resource

The configuration store along with all resource properties. The Configuration Store will have all information to begin utilizing it.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – The resource ID.
name (str) – The name of the resource.
type (str) – The type of the resource.
provisioning_state (str or ProvisioningState) – The provisioning state of the configuration store. Possible values include: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Canceled”.
creation_date (datetime) – The creation date of configuration store.
endpoint (str) – The DNS endpoint where the configuration store API will be available.
private_endpoint_connections (list[PrivateEndpointConnectionReference]) – The list of private endpoint connections that are set up for this resource.

Parameters

location (str) – Required. The location of the resource. This cannot be changed after the resource is created.
tags (dict[str, str]) – A set of tags. The tags of the resource.
identity (ResourceIdentity) – The managed identity information, if configured.
sku (Sku) – Required. The sku of the configuration store.
encryption (EncryptionProperties) – The encryption settings of the configuration store.
public_network_access (str or PublicNetworkAccess) – Control permission for data plane traffic coming from public networks while private endpoint is enabled. Possible values include: “Enabled”, “Disabled”.

class azure.mgmt.appconfiguration.models.ConfigurationStoreListResult(*, value: Optional[List[ConfigurationStore]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The result of a request to list configuration stores.

Parameters

value (list[ConfigurationStore]) – The collection value.
next_link (str) – The URI that can be used to request the next set of paged results.

class azure.mgmt.appconfiguration.models.ConfigurationStoreUpdateParameters(*, identity: Optional[ResourceIdentity] = None, sku: Optional[Sku] = None, tags: Optional[Dict[str, str]] = None, encryption: Optional[EncryptionProperties] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The parameters for updating a configuration store.

Parameters

identity (ResourceIdentity) – The managed identity information for the configuration store.
sku (Sku) – The SKU of the configuration store.
tags (dict[str, str]) – A set of tags. The ARM resource tags.
encryption (EncryptionProperties) – The encryption settings of the configuration store.

class azure.mgmt.appconfiguration.models.ConnectionStatus(value)[source]¶

Bases: str, enum.Enum

The private link service connection status.

approved = 'Approved'¶

disconnected = 'Disconnected'¶

pending = 'Pending'¶

rejected = 'Rejected'¶

class azure.mgmt.appconfiguration.models.EncryptionProperties(*, key_vault_properties: Optional[KeyVaultProperties] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The encryption settings for a configuration store.

Parameters: key_vault_properties (KeyVaultProperties) – Key vault properties.

class azure.mgmt.appconfiguration.models.Error(*, code: Optional[str] = None, message: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

AppConfiguration error object.

Parameters

code (str) – Error code.
message (str) – Error message.

class azure.mgmt.appconfiguration.models.IdentityType(value)[source]¶

Bases: str, enum.Enum

The type of managed identity used. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user-assigned identities. The type ‘None’ will remove any identities.

none = 'None'¶

system_assigned = 'SystemAssigned'¶

system_assigned_user_assigned = 'SystemAssigned, UserAssigned'¶

user_assigned = 'UserAssigned'¶

class azure.mgmt.appconfiguration.models.KeyValue(**kwargs)[source]¶

Bases: msrest.serialization.Model

The result of a request to retrieve a key-value from the specified configuration store.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

key (str) – The primary identifier of a key-value. The key is used in unison with the label to uniquely identify a key-value.
label (str) – A value used to group key-values. The label is used in unison with the key to uniquely identify a key-value.
value (str) – The value of the key-value.
content_type (str) – The content type of the key-value’s value. Providing a proper content-type can enable transformations of values when they are retrieved by applications.
e_tag (str) – An ETag indicating the state of a key-value within a configuration store.
last_modified (datetime) – The last time a modifying operation was performed on the given key-value.
locked (bool) – A value indicating whether the key-value is locked. A locked key-value may not be modified until it is unlocked.
tags (dict[str, str]) – A set of tags. A dictionary of tags that can help identify what a key-value may be applicable for.

class azure.mgmt.appconfiguration.models.KeyVaultProperties(*, key_identifier: Optional[str] = None, identity_client_id: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Settings concerning key vault encryption for a configuration store.

Parameters

key_identifier (str) – The URI of the key vault key used to encrypt data.
identity_client_id (str) – The client id of the identity which will be used to access key vault.

class azure.mgmt.appconfiguration.models.ListKeyValueParameters(*, key: str, label: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The parameters used to list a configuration store key-value.

All required parameters must be populated in order to send to Azure.

Parameters

key (str) – Required. The key to retrieve.
label (str) – The label of the key.

class azure.mgmt.appconfiguration.models.NameAvailabilityStatus(**kwargs)[source]¶

Bases: msrest.serialization.Model

The result of a request to check the availability of a resource name.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

name_available (bool) – The value indicating whether the resource name is available.
message (str) – If any, the error message that provides more detail for the reason that the name is not available.
reason (str) – If any, the reason that the name is not available.

class azure.mgmt.appconfiguration.models.OperationDefinition(*, name: Optional[str] = None, display: Optional[OperationDefinitionDisplay] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The definition of a configuration store operation.

Parameters

name (str) – Operation name: {provider}/{resource}/{operation}.
display (OperationDefinitionDisplay) – The display information for the configuration store operation.

class azure.mgmt.appconfiguration.models.OperationDefinitionDisplay(*, resource: Optional[str] = None, operation: Optional[str] = None, description: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The display information for a configuration store operation.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

provider (str) – The resource provider name: Microsoft App Configuration.”.

Parameters

resource (str) – The resource on which the operation is performed.
operation (str) – The operation that users can perform.
description (str) – The description for the operation.

class azure.mgmt.appconfiguration.models.OperationDefinitionListResult(*, value: Optional[List[OperationDefinition]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The result of a request to list configuration store operations.

Parameters

value (list[OperationDefinition]) – The collection value.
next_link (str) – The URI that can be used to request the next set of paged results.

class azure.mgmt.appconfiguration.models.PrivateEndpoint(*, id: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

Private endpoint which a connection belongs to.

Parameters: id (str) – The resource Id for private endpoint.

class azure.mgmt.appconfiguration.models.PrivateEndpointConnection(*, private_endpoint: Optional[PrivateEndpoint] = None, private_link_service_connection_state: Optional[PrivateLinkServiceConnectionState] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A private endpoint connection.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The resource ID.
name (str) – The name of the resource.
type (str) – The type of the resource.
provisioning_state (str or ProvisioningState) – The provisioning status of the private endpoint connection. Possible values include: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Canceled”.

Parameters

private_endpoint (PrivateEndpoint) – The resource of private endpoint.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.

class azure.mgmt.appconfiguration.models.PrivateEndpointConnectionListResult(*, value: Optional[List[PrivateEndpointConnection]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A list of private endpoint connections.

Parameters

value (list[PrivateEndpointConnection]) – The collection value.
next_link (str) – The URI that can be used to request the next set of paged results.

class azure.mgmt.appconfiguration.models.PrivateEndpointConnectionReference(*, private_endpoint: Optional[PrivateEndpoint] = None, private_link_service_connection_state: Optional[PrivateLinkServiceConnectionState] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A reference to a related private endpoint connection.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The resource ID.
name (str) – The name of the resource.
type (str) – The type of the resource.
provisioning_state (str or ProvisioningState) – The provisioning status of the private endpoint connection. Possible values include: “Creating”, “Updating”, “Deleting”, “Succeeded”, “Failed”, “Canceled”.

Parameters

private_endpoint (PrivateEndpoint) – The resource of private endpoint.
private_link_service_connection_state (PrivateLinkServiceConnectionState) – A collection of information about the state of the connection between service consumer and provider.

class azure.mgmt.appconfiguration.models.PrivateLinkResource(**kwargs)[source]¶

Bases: msrest.serialization.Model

A resource that supports private link capabilities.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

id (str) – The resource ID.
name (str) – The name of the resource.
type (str) – The type of the resource.
group_id (str) – The private link resource group id.
required_members (list[str]) – The private link resource required member names.
required_zone_names (list[str]) – The list of required DNS zone names of the private link resource.

class azure.mgmt.appconfiguration.models.PrivateLinkResourceListResult(*, value: Optional[List[PrivateLinkResource]] = None, next_link: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

A list of private link resources.

Parameters

value (list[PrivateLinkResource]) – The collection value.
next_link (str) – The URI that can be used to request the next set of paged results.

class azure.mgmt.appconfiguration.models.PrivateLinkServiceConnectionState(*, status: Optional[Union[str, ConnectionStatus]] = None, description: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The state of a private link service connection.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

status (str or ConnectionStatus) – The private link service connection status. Possible values include: “Pending”, “Approved”, “Rejected”, “Disconnected”.
description (str) – The private link service connection description.

Variables

actions_required (str or ActionsRequired) – Any action that is required beyond basic workflow (approve/ reject/ disconnect). Possible values include: “None”, “Recreate”.

class azure.mgmt.appconfiguration.models.ProvisioningState(value)[source]¶

Bases: str, enum.Enum

The provisioning state of the configuration store.

canceled = 'Canceled'¶

creating = 'Creating'¶

deleting = 'Deleting'¶

failed = 'Failed'¶

succeeded = 'Succeeded'¶

updating = 'Updating'¶

class azure.mgmt.appconfiguration.models.PublicNetworkAccess(value)[source]¶

Bases: str, enum.Enum

Control permission for data plane traffic coming from public networks while private endpoint is enabled.

disabled = 'Disabled'¶

enabled = 'Enabled'¶

class azure.mgmt.appconfiguration.models.RegenerateKeyParameters(*, id: Optional[str] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

The parameters used to regenerate an API key.

Parameters: id (str) – The id of the key to regenerate.

class azure.mgmt.appconfiguration.models.Resource(*, location: str, tags: Optional[Dict[str, str]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

An Azure resource.

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Variables

id (str) – The resource ID.
name (str) – The name of the resource.
type (str) – The type of the resource.

Parameters

location (str) – Required. The location of the resource. This cannot be changed after the resource is created.
tags (dict[str, str]) – A set of tags. The tags of the resource.

class azure.mgmt.appconfiguration.models.ResourceIdentity(*, type: Optional[Union[str, IdentityType]] = None, user_assigned_identities: Optional[Dict[str, UserIdentity]] = None, **kwargs)[source]¶

Bases: msrest.serialization.Model

An identity that can be associated with a resource.

Variables are only populated by the server, and will be ignored when sending a request.

Parameters

type (str or IdentityType) – The type of managed identity used. The type ‘SystemAssigned, UserAssigned’ includes both an implicitly created identity and a set of user-assigned identities. The type ‘None’ will remove any identities. Possible values include: “None”, “SystemAssigned”, “UserAssigned”, “SystemAssigned, UserAssigned”.
user_assigned_identities (dict[str, UserIdentity]) – The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}’.

Variables

principal_id (str) – The principal id of the identity. This property will only be provided for a system-assigned identity.
tenant_id (str) – The tenant id associated with the resource’s identity. This property will only be provided for a system-assigned identity.

class azure.mgmt.appconfiguration.models.Sku(*, name: str, **kwargs)[source]¶

Bases: msrest.serialization.Model

Describes a configuration store SKU.

All required parameters must be populated in order to send to Azure.

Parameters: name (str) – Required. The SKU name of the configuration store.

class azure.mgmt.appconfiguration.models.UserIdentity(**kwargs)[source]¶

Bases: msrest.serialization.Model

A resource identity that is managed by the user of the service.

Variables are only populated by the server, and will be ignored when sending a request.

Variables

principal_id (str) – The principal ID of the user-assigned identity.
client_id (str) – The client ID of the user-assigned identity.