isp_customers

Creates, updates, deletes, gets or lists an isp_customers resource.

Overview

Name	isp_customers
Type	Resource
Id	azure_extras.connected_cache.isp_customers

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalCustomerProperties	object	Mcc customer resource additional properties.
customer	object	Mcc customer resource (customer entity).
error	object	Mcc response error details.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioned state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Unknown", "Accepted", "Upgrading", and "Deleting". (Succeeded, Failed, Canceled, Unknown, Accepted, Upgrading, Deleting)
status	string	HTTP error status code.
statusCode	string	Mcc response status code.
statusDetails	string	Mcc response status details for retrieving response inner details.
statusText	string	Mcc response status text as string for retrieving status details.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalCustomerProperties	object	Mcc customer resource additional properties.
customer	object	Mcc customer resource (customer entity).
error	object	Mcc response error details.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioned state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Unknown", "Accepted", "Upgrading", and "Deleting". (Succeeded, Failed, Canceled, Unknown, Accepted, Upgrading, Deleting)
status	string	HTTP error status code.
statusCode	string	Mcc response status code.
statusDetails	string	Mcc response status details for retrieving response inner details.
statusText	string	Mcc response status text as string for retrieving status details.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
additionalCustomerProperties	object	Mcc customer resource additional properties.
customer	object	Mcc customer resource (customer entity).
error	object	Mcc response error details.
location	string	The geo-location where the resource lives. Required.
provisioningState	string	The provisioned state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Unknown", "Accepted", "Upgrading", and "Deleting". (Succeeded, Failed, Canceled, Unknown, Accepted, Upgrading, Deleting)
status	string	HTTP error status code.
statusCode	string	Mcc response status code.
statusDetails	string	Mcc response status details for retrieving response inner details.
statusText	string	Mcc response status text as string for retrieving status details.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, customer_resource_name, subscription_id		Gets the ispCustomer resource information using this get call.
list_by_resource_group	select	resource_group_name, subscription_id		This api gets the information about all ispCustomer resources under the given subscription and resource group.
list_by_subscription	select	subscription_id		This api gets information about all ispCustomer resources under the given subscription.
create_or_update	insert	resource_group_name, customer_resource_name, subscription_id, location		This api creates an ispCustomer with the specified create parameters.
update	update	resource_group_name, customer_resource_name, subscription_id		This api updates an existing ispCustomer resource.
create_or_update	replace	resource_group_name, customer_resource_name, subscription_id, location		This api creates an ispCustomer with the specified create parameters.
delete	delete	resource_group_name, customer_resource_name, subscription_id		This api deletes an existing ispCustomer resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
customer_resource_name	string	Name of the Customer resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the ispCustomer resource information using this get call.

SELECT
id,
name,
additionalCustomerProperties,
customer,
error,
location,
provisioningState,
status,
statusCode,
statusDetails,
statusText,
systemData,
tags,
type
FROM azure_extras.connected_cache.isp_customers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND customer_resource_name = '{{ customer_resource_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

This api gets the information about all ispCustomer resources under the given subscription and resource group.

SELECT
id,
name,
additionalCustomerProperties,
customer,
error,
location,
provisioningState,
status,
statusCode,
statusDetails,
statusText,
systemData,
tags,
type
FROM azure_extras.connected_cache.isp_customers
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

This api gets information about all ispCustomer resources under the given subscription.

SELECT
id,
name,
additionalCustomerProperties,
customer,
error,
location,
provisioningState,
status,
statusCode,
statusDetails,
statusText,
systemData,
tags,
type
FROM azure_extras.connected_cache.isp_customers
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

This api creates an ispCustomer with the specified create parameters.

INSERT INTO azure_extras.connected_cache.isp_customers (
tags,
location,
properties,
resource_group_name,
customer_resource_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ customer_resource_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: isp_customers
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the isp_customers resource.
  - name: customer_resource_name
    value: "{{ customer_resource_name }}"
    description: Required parameter for the isp_customers resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the isp_customers resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      customer:
        fullyQualifiedResourceId: "{{ fullyQualifiedResourceId }}"
        customerId: "{{ customerId }}"
        customerName: "{{ customerName }}"
        contactEmail: "{{ contactEmail }}"
        contactPhone: "{{ contactPhone }}"
        contactName: "{{ contactName }}"
        isEntitled: {{ isEntitled }}
        releaseVersion: {{ releaseVersion }}
        createAsyncOperationId: "{{ createAsyncOperationId }}"
        deleteAsyncOperationId: "{{ deleteAsyncOperationId }}"
        clientTenantId: "{{ clientTenantId }}"
        synchWithAzureAttemptsCount: {{ synchWithAzureAttemptsCount }}
        lastSyncWithAzureTimestamp: "{{ lastSyncWithAzureTimestamp }}"
        isEnterpriseManaged: {{ isEnterpriseManaged }}
        shouldMigrate: {{ shouldMigrate }}
        resendSignupCode: {{ resendSignupCode }}
        verifySignupCode: {{ verifySignupCode }}
        verifySignupPhrase: "{{ verifySignupPhrase }}"
      additionalCustomerProperties:
        customerPropertiesOverviewCacheEfficiency: {{ customerPropertiesOverviewCacheEfficiency }}
        customerPropertiesOverviewAverageEgressMbps: {{ customerPropertiesOverviewAverageEgressMbps }}
        customerPropertiesOverviewAverageMissMbps: {{ customerPropertiesOverviewAverageMissMbps }}
        customerPropertiesOverviewEgressMbpsMax: {{ customerPropertiesOverviewEgressMbpsMax }}
        customerPropertiesOverviewEgressMbpsMaxDateTime: "{{ customerPropertiesOverviewEgressMbpsMaxDateTime }}"
        customerPropertiesOverviewMissMbpsMax: {{ customerPropertiesOverviewMissMbpsMax }}
        customerPropertiesOverviewMissMbpsMaxDateTime: "{{ customerPropertiesOverviewMissMbpsMaxDateTime }}"
        customerPropertiesOverviewCacheNodesHealthyCount: {{ customerPropertiesOverviewCacheNodesHealthyCount }}
        customerPropertiesOverviewCacheNodesUnhealthyCount: {{ customerPropertiesOverviewCacheNodesUnhealthyCount }}
        signupStatus: {{ signupStatus }}
        signupStatusCode: {{ signupStatusCode }}
        signupStatusText: "{{ signupStatusText }}"
        signupPhaseStatusCode: {{ signupPhaseStatusCode }}
        signupPhaseStatusText: "{{ signupPhaseStatusText }}"
        peeringDbLastUpdateDate: "{{ peeringDbLastUpdateDate }}"
        customerOrgName: "{{ customerOrgName }}"
        customerEmail: "{{ customerEmail }}"
        customerTransitAsn: "{{ customerTransitAsn }}"
        customerTransitState: "{{ customerTransitState }}"
        customerAsn: "{{ customerAsn }}"
        customerAsnEstimatedEgressPeekGbps: {{ customerAsnEstimatedEgressPeekGbps }}
        customerEntitlementSkuId: "{{ customerEntitlementSkuId }}"
        customerEntitlementSkuGuid: "{{ customerEntitlementSkuGuid }}"
        customerEntitlementSkuName: "{{ customerEntitlementSkuName }}"
        customerEntitlementExpiration: "{{ customerEntitlementExpiration }}"
        optionalProperty1: "{{ optionalProperty1 }}"
        optionalProperty2: "{{ optionalProperty2 }}"
        optionalProperty3: "{{ optionalProperty3 }}"
        optionalProperty4: "{{ optionalProperty4 }}"
        optionalProperty5: "{{ optionalProperty5 }}"
      statusCode: "{{ statusCode }}"
      statusText: "{{ statusText }}"
      statusDetails: "{{ statusDetails }}"
      status: "{{ status }}"
      error:
        code: "{{ code }}"
        message: "{{ message }}"
        target: "{{ target }}"
        details:
          - code: "{{ code }}"
            message: "{{ message }}"
            target: "{{ target }}"
            details: "{{ details }}"
            additionalInfo: "{{ additionalInfo }}"
        additionalInfo:
          - type: "{{ type }}"
            info: "{{ info }}"

UPDATE examples

update

This api updates an existing ispCustomer resource.

UPDATE azure_extras.connected_cache.isp_customers
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND customer_resource_name = '{{ customer_resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

This api creates an ispCustomer with the specified create parameters.

REPLACE azure_extras.connected_cache.isp_customers
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND customer_resource_name = '{{ customer_resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

This api deletes an existing ispCustomer resource.

DELETE FROM azure_extras.connected_cache.isp_customers
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND customer_resource_name = '{{ customer_resource_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;