Skip to main content

AppServiceCertificateOrderCertificate

Provides a AppServiceCertificateOrderCertificate from the CertificateRegistration group

Examples​

Create Certificate​

exports.createResources = () => [
  {
    type: "AppServiceCertificateOrderCertificate",
    group: "CertificateRegistration",
    name: "myAppServiceCertificateOrderCertificate",
    properties: () => ({
      location: "Global",
      properties: {
        keyVaultId:
          "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/microsoft.keyvault/vaults/SamplevaultName",
        keyVaultSecretName: "SampleSecretName1",
      },
    }),
    dependencies: ({}) => ({
      resourceGroup: "myResourceGroup",
      certificateOrder: "myAppServiceCertificateOrder",
    }),
  },
];

Dependencies​

Swagger Schema​

{
  description: 'Key Vault container ARM resource for a certificate that is purchased through Azure.',
  type: 'object',
  allOf: [
    {
      description: 'Azure resource. This resource is tracked in Azure Resource Manager',
      required: [ 'location' ],
      type: 'object',
      properties: {
        id: { description: 'Resource Id.', type: 'string', readOnly: true },
        name: {
          description: 'Resource Name.',
          type: 'string',
          readOnly: true
        },
        kind: { description: 'Kind of resource.', type: 'string' },
        location: { description: 'Resource Location.', type: 'string' },
        type: {
          description: 'Resource type.',
          type: 'string',
          readOnly: true
        },
        tags: {
          description: 'Resource tags.',
          type: 'object',
          additionalProperties: { type: 'string' }
        }
      },
      'x-ms-azure-resource': true
    }
  ],
  properties: {
    properties: {
      description: 'Core resource properties',
      type: 'object',
      'x-ms-client-flatten': true,
      properties: {
        keyVaultId: { description: 'Key Vault resource Id.', type: 'string' },
        keyVaultSecretName: { description: 'Key Vault secret name.', type: 'string' },
        provisioningState: {
          description: 'Status of the Key Vault secret.',
          enum: [
            'Initialized',
            'WaitingOnCertificateOrder',
            'Succeeded',
            'CertificateOrderFailed',
            'OperationNotPermittedOnKeyVault',
            'AzureServiceUnauthorizedToAccessKeyVault',
            'KeyVaultDoesNotExist',
            'KeyVaultSecretDoesNotExist',
            'UnknownError',
            'ExternalPrivateKey',
            'Unknown'
          ],
          type: 'string',
          readOnly: true,
          'x-ms-enum': { name: 'KeyVaultSecretStatus', modelAsString: false }
        }
      }
    }
  }
}

Misc​

The resource version is 2022-03-01.

The Swagger schema used to generate this documentation can be found here.