Microsoft.ConnectedCache ispCustomers 2023-05-01-preview

2024-12-09

Bicep resource definition

The ispCustomers resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ConnectedCache/ispCustomers resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ConnectedCache/ispCustomers@2023-05-01-preview' = {
  location: 'string'
  name: 'string'
  properties: {
    additionalCustomerProperties: {
      customerAsn: 'string'
      customerEmail: 'string'
      customerEntitlementExpiration: 'string'
      customerEntitlementSkuGuid: 'string'
      customerEntitlementSkuId: 'string'
      customerEntitlementSkuName: 'string'
      customerTransitAsn: 'string'
      customerTransitState: 'string'
      optionalProperty1: 'string'
      optionalProperty2: 'string'
      optionalProperty3: 'string'
      optionalProperty4: 'string'
      optionalProperty5: 'string'
    }
    customer: {
      clientTenantId: 'string'
      contactEmail: 'string'
      contactName: 'string'
      contactPhone: 'string'
      customerName: 'string'
      fullyQualifiedResourceId: 'string'
      isEnterpriseManaged: bool
      isEntitled: bool
      releaseVersion: int
      resendSignupCode: bool
      shouldMigrate: bool
      verifySignupCode: bool
      verifySignupPhrase: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.ConnectedCache/ispCustomers

Name	Description	Value
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 90 Pattern = `^[a-zA-Z0-9\_\-]*` (required)
properties	The resource-specific properties for this resource.	CustomerProperty
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

AdditionalCustomerProperties

Name	Description	Value
customerAsn	Customer resource Asn (autonomous system number).	string
customerEmail	Customer resource contact email.	string
customerEntitlementExpiration	Customer resource entitlement expiration date string.	string
customerEntitlementSkuGuid	Customer resource entitlement Sku Guid.	string
customerEntitlementSkuId	Customer resource entitlement Sku Id.	string
customerEntitlementSkuName	Customer resource entitlement Sku name.	string
customerTransitAsn	Customer resource transit Asn (autonomous system number).	string
customerTransitState	Customer resource transit state.	'CombinedTransit' 'NoTransit' 'TransitOnly'
optionalProperty1	Optional property #1 of Mcc response object.	string
optionalProperty2	Optional property #2 of Mcc response object.	string
optionalProperty3	Optional property #3 of Mcc response object.	string
optionalProperty4	Optional property #4 of Mcc response object.	string
optionalProperty5	Optional property #5 of Mcc response object.	string

CustomerEntity

Name	Description	Value
clientTenantId	Customer resource client tenant Id of subscription.	string
contactEmail	Customer resource contact email.	string
contactName	Customer resource contact full name.	string
contactPhone	Customer resource contact phone.	string
customerName	Customer resource name.	string
fullyQualifiedResourceId	Customer resource Azure fully qualified resource Id.	string
isEnterpriseManaged	Customer resource flag for enterprise management as boolean.	bool
isEntitled	Customer resource entitlement flag as boolean.	bool
releaseVersion	Customer resource Mcc release version.	int
resendSignupCode	Customer resource flag for resending signup code as boolean.	bool
shouldMigrate	Customer resource flag for migration.	bool
verifySignupCode	Customer resource flag for requiring verification of signup code as boolean.	bool
verifySignupPhrase	Customer resource phrase for verifying signup.	string Constraints: Sensitive value. Pass in as a secure parameter.

CustomerProperty

Name	Description	Value
additionalCustomerProperties	Mcc customer resource additional properties.	AdditionalCustomerProperties
customer	Mcc customer resource (customer entity).	CustomerEntity

TrackedResourceTags

Name	Description	Value

ARM template resource definition

The ispCustomers resource type can be deployed with operations that target:

Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ConnectedCache/ispCustomers resource, add the following JSON to your template.

{
  "type": "Microsoft.ConnectedCache/ispCustomers",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "location": "string",
  "properties": {
    "additionalCustomerProperties": {
      "customerAsn": "string",
      "customerEmail": "string",
      "customerEntitlementExpiration": "string",
      "customerEntitlementSkuGuid": "string",
      "customerEntitlementSkuId": "string",
      "customerEntitlementSkuName": "string",
      "customerTransitAsn": "string",
      "customerTransitState": "string",
      "optionalProperty1": "string",
      "optionalProperty2": "string",
      "optionalProperty3": "string",
      "optionalProperty4": "string",
      "optionalProperty5": "string"
    },
    "customer": {
      "clientTenantId": "string",
      "contactEmail": "string",
      "contactName": "string",
      "contactPhone": "string",
      "customerName": "string",
      "fullyQualifiedResourceId": "string",
      "isEnterpriseManaged": "bool",
      "isEntitled": "bool",
      "releaseVersion": "int",
      "resendSignupCode": "bool",
      "shouldMigrate": "bool",
      "verifySignupCode": "bool",
      "verifySignupPhrase": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.ConnectedCache/ispCustomers

Name	Description	Value
apiVersion	The api version	'2023-05-01-preview'
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 90 Pattern = `^[a-zA-Z0-9\_\-]*` (required)
properties	The resource-specific properties for this resource.	CustomerProperty
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.ConnectedCache/ispCustomers'

AdditionalCustomerProperties

Name	Description	Value
customerAsn	Customer resource Asn (autonomous system number).	string
customerEmail	Customer resource contact email.	string
customerEntitlementExpiration	Customer resource entitlement expiration date string.	string
customerEntitlementSkuGuid	Customer resource entitlement Sku Guid.	string
customerEntitlementSkuId	Customer resource entitlement Sku Id.	string
customerEntitlementSkuName	Customer resource entitlement Sku name.	string
customerTransitAsn	Customer resource transit Asn (autonomous system number).	string
customerTransitState	Customer resource transit state.	'CombinedTransit' 'NoTransit' 'TransitOnly'
optionalProperty1	Optional property #1 of Mcc response object.	string
optionalProperty2	Optional property #2 of Mcc response object.	string
optionalProperty3	Optional property #3 of Mcc response object.	string
optionalProperty4	Optional property #4 of Mcc response object.	string
optionalProperty5	Optional property #5 of Mcc response object.	string

CustomerEntity

Name	Description	Value
clientTenantId	Customer resource client tenant Id of subscription.	string
contactEmail	Customer resource contact email.	string
contactName	Customer resource contact full name.	string
contactPhone	Customer resource contact phone.	string
customerName	Customer resource name.	string
fullyQualifiedResourceId	Customer resource Azure fully qualified resource Id.	string
isEnterpriseManaged	Customer resource flag for enterprise management as boolean.	bool
isEntitled	Customer resource entitlement flag as boolean.	bool
releaseVersion	Customer resource Mcc release version.	int
resendSignupCode	Customer resource flag for resending signup code as boolean.	bool
shouldMigrate	Customer resource flag for migration.	bool
verifySignupCode	Customer resource flag for requiring verification of signup code as boolean.	bool
verifySignupPhrase	Customer resource phrase for verifying signup.	string Constraints: Sensitive value. Pass in as a secure parameter.

CustomerProperty

Name	Description	Value
additionalCustomerProperties	Mcc customer resource additional properties.	AdditionalCustomerProperties
customer	Mcc customer resource (customer entity).	CustomerEntity

TrackedResourceTags

Name	Description	Value

Usage Examples

Terraform (AzAPI provider) resource definition

The ispCustomers resource type can be deployed with operations that target:

Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ConnectedCache/ispCustomers resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ConnectedCache/ispCustomers@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      additionalCustomerProperties = {
        customerAsn = "string"
        customerEmail = "string"
        customerEntitlementExpiration = "string"
        customerEntitlementSkuGuid = "string"
        customerEntitlementSkuId = "string"
        customerEntitlementSkuName = "string"
        customerTransitAsn = "string"
        customerTransitState = "string"
        optionalProperty1 = "string"
        optionalProperty2 = "string"
        optionalProperty3 = "string"
        optionalProperty4 = "string"
        optionalProperty5 = "string"
      }
      customer = {
        clientTenantId = "string"
        contactEmail = "string"
        contactName = "string"
        contactPhone = "string"
        customerName = "string"
        fullyQualifiedResourceId = "string"
        isEnterpriseManaged = bool
        isEntitled = bool
        releaseVersion = int
        resendSignupCode = bool
        shouldMigrate = bool
        verifySignupCode = bool
        verifySignupPhrase = "string"
      }
    }
  }
}

Property Values

Microsoft.ConnectedCache/ispCustomers

Name	Description	Value
location	The geo-location where the resource lives	string (required)
name	The resource name	string Constraints: Min length = 1 Max length = 90 Pattern = `^[a-zA-Z0-9\_\-]*` (required)
properties	The resource-specific properties for this resource.	CustomerProperty
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.ConnectedCache/ispCustomers@2023-05-01-preview"

AdditionalCustomerProperties

Name	Description	Value
customerAsn	Customer resource Asn (autonomous system number).	string
customerEmail	Customer resource contact email.	string
customerEntitlementExpiration	Customer resource entitlement expiration date string.	string
customerEntitlementSkuGuid	Customer resource entitlement Sku Guid.	string
customerEntitlementSkuId	Customer resource entitlement Sku Id.	string
customerEntitlementSkuName	Customer resource entitlement Sku name.	string
customerTransitAsn	Customer resource transit Asn (autonomous system number).	string
customerTransitState	Customer resource transit state.	'CombinedTransit' 'NoTransit' 'TransitOnly'
optionalProperty1	Optional property #1 of Mcc response object.	string
optionalProperty2	Optional property #2 of Mcc response object.	string
optionalProperty3	Optional property #3 of Mcc response object.	string
optionalProperty4	Optional property #4 of Mcc response object.	string
optionalProperty5	Optional property #5 of Mcc response object.	string

CustomerEntity

Name	Description	Value
clientTenantId	Customer resource client tenant Id of subscription.	string
contactEmail	Customer resource contact email.	string
contactName	Customer resource contact full name.	string
contactPhone	Customer resource contact phone.	string
customerName	Customer resource name.	string
fullyQualifiedResourceId	Customer resource Azure fully qualified resource Id.	string
isEnterpriseManaged	Customer resource flag for enterprise management as boolean.	bool
isEntitled	Customer resource entitlement flag as boolean.	bool
releaseVersion	Customer resource Mcc release version.	int
resendSignupCode	Customer resource flag for resending signup code as boolean.	bool
shouldMigrate	Customer resource flag for migration.	bool
verifySignupCode	Customer resource flag for requiring verification of signup code as boolean.	bool
verifySignupPhrase	Customer resource phrase for verifying signup.	string Constraints: Sensitive value. Pass in as a secure parameter.

CustomerProperty

Name	Description	Value
additionalCustomerProperties	Mcc customer resource additional properties.	AdditionalCustomerProperties
customer	Mcc customer resource (customer entity).	CustomerEntity

TrackedResourceTags

Name	Description	Value

Share via

Microsoft.ConnectedCache ispCustomers 2023-05-01-preview

Bicep resource definition

Resource format

Property Values

Microsoft.ConnectedCache/ispCustomers

AdditionalCustomerProperties

CustomerEntity

CustomerProperty

TrackedResourceTags

ARM template resource definition

Resource format

Property Values

Microsoft.ConnectedCache/ispCustomers

AdditionalCustomerProperties

CustomerEntity

CustomerProperty

TrackedResourceTags

Usage Examples

Terraform (AzAPI provider) resource definition

Resource format

Property Values

Microsoft.ConnectedCache/ispCustomers

AdditionalCustomerProperties

CustomerEntity

CustomerProperty

TrackedResourceTags

Feedback

Additional resources