The Microsoft Azure Deployment Admin Client is a tool that allows users to manage and deploy resources on the Azure platform. This includes setting up virtual machines, managing databases, and configuring network security groups. The client provides a user-friendly interface for administrators to easily monitor and track the status of their deployments, as well as troubleshoot any issues that may arise.
swagger: '2.0'
info:
version: '2019-01-01'
title: Microsoft Azure DeploymentAdminClient
description: Deployment Admin Client.
host: management.azure.com
schemes:
- https
paths:
/subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productPackages/{packageId}/secrets:
get:
x-ms-examples:
Return product secrets list.:
$ref: ./examples/ProductSecret/List.json
description: Returns an array of product secrets.
tags:
- ProductSecrets
operationId: microsoftAzureProductsecretsList
parameters:
- $ref: Deployment.json#/parameters/SubscriptionIdParameter
- $ref: Deployment.json#/parameters/ApiVersionParameter
- $ref: Deployment.json#/parameters/PackageIdParameter
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProductSecretsList'
default:
description: Default Response.
schema:
$ref: Deployment.json#/definitions/ExtendedErrorInfo
produces:
- application/json
consumes:
- application/json
x-ms-pageable:
nextLinkName: nextLink
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Deployment Admin Locations Global Productpackages Packageid Secrets
? /subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productPackages/{packageId}/secrets/{secretName}
: get:
x-ms-examples:
Return product secrets list.:
$ref: ./examples/ProductSecret/Get.Json
description: Returns the specific product secret.
tags:
- ProductSecrets
operationId: microsoftAzureProductsecretsGet
parameters:
- $ref: Deployment.json#/parameters/SubscriptionIdParameter
- $ref: Deployment.json#/parameters/ApiVersionParameter
- $ref: Deployment.json#/parameters/PackageIdParameter
- $ref: '#/parameters/SecretNameParameter'
responses:
'200':
description: OK
schema:
$ref: '#/definitions/ProductSecret'
default:
description: Default Response.
schema:
$ref: Deployment.json#/definitions/ExtendedErrorInfo
produces:
- application/json
consumes:
- application/json
summary: >-
Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Deployment Admin Locations Global Productpackages Packageid Secrets Secretname
? /subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productPackages/{packageId}/secrets/{secretName}/import
: post:
x-ms-examples:
Imports a product secret.:
$ref: ./examples/ProductSecret/Import.json
description: Imports a product secret.
tags:
- ProductSecrets
operationId: microsoftAzureProductsecretsSet
parameters:
- $ref: Deployment.json#/parameters/SubscriptionIdParameter
- $ref: Deployment.json#/parameters/PackageIdParameter
- $ref: '#/parameters/SecretNameParameter'
- $ref: Deployment.json#/parameters/ApiVersionParameter
- $ref: '#/parameters/SecretParameters'
responses:
'200':
description: Accepted
default:
description: Default Response.
schema:
$ref: Deployment.json#/definitions/ExtendedErrorInfo
x-ms-long-running-operation: true
produces:
- application/json
consumes:
- application/json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Deployment Admin Locations Global Productpackages Packageid Secrets Secretname Import
? /subscriptions/{subscriptionId}/providers/Microsoft.Deployment.Admin/locations/global/productPackages/{packageId}/secrets/{secretName}/validate
: post:
x-ms-examples:
Validates a product secret.:
$ref: ./examples/ProductSecret/Validate.json
description: Validates a product secret.
tags:
- ProductSecrets
operationId: microsoftAzureProductsecretsValidate
parameters:
- $ref: Deployment.json#/parameters/SubscriptionIdParameter
- $ref: Deployment.json#/parameters/PackageIdParameter
- $ref: '#/parameters/SecretNameParameter'
- $ref: Deployment.json#/parameters/ApiVersionParameter
- $ref: '#/parameters/SecretParameters'
responses:
'200':
description: Accepted
default:
description: Default Response.
schema:
$ref: Deployment.json#/definitions/ExtendedErrorInfo
x-ms-long-running-operation: true
produces:
- application/json
consumes:
- application/json
summary: >-
Microsoft Azure Post Subscriptions Subscriptionid Providers Microsoft Deployment Admin Locations Global Productpackages Packageid Secrets Secretname Validate
definitions:
ProductSecret:
description: Properties for a product secret.
type: object
properties:
properties:
description: Properties of a product secret.
$ref: '#/definitions/ProductSecretProperties'
x-ms-client-flatten: true
allOf:
- $ref: Deployment.json#/definitions/Resource
ProductSecretsList:
description: List of product secrets.
properties:
value:
description: List of product secrets.
type: array
items:
$ref: '#/definitions/ProductSecret'
nextLink:
description: URI to the next page.
type: string
ProductSecretProperties:
type: object
description: Properties of product secret.
properties:
secretState:
description: The secret state.
$ref: '#/definitions/SecretState'
secretDescriptor:
description: The secret type-specific descriptor.
$ref: '#/definitions/SecretDescriptor'
expiresAfter:
description: The expiration period of the secret (in ISO8601 format).
type: string
description:
description: The secret description.
type: string
provisioningState:
description: Provisioning state of the resource.
type: string
secretKind:
description: Specifies the secret kind.
type: string
enum:
- AdHoc
- Certificate
- Password
- StorageAccount
- SymmetricKey
x-ms-enum:
modelAsString: true
name: SecretKind
SecretDescriptor:
description: The secret type-specific descriptor.
type: object
properties:
keyLength:
description: The key length.
type: integer
alternativeDnsNames:
description: Alternative DNS Names.
type: array
items:
$ref: '#/definitions/AlternativeDnsNames'
secondaryKeyIsActive:
description: >-
A value indicating whether the secondary or primary storage account
key is active as a secret.
type: boolean
rotationStatus:
description: The storage account key secret rotation status.
type: string
enum:
- None
- PlantNewSak
- RotateInactiveSak
- Complete
x-ms-enum:
modelAsString: true
name: RotationStatus
passwordLength:
description: >-
The minimum password length is 8 characters, and the maximum password
length is 128 characters.
type: integer
allowedCharacters:
description: The allowed characters in the password
type: string
passwordValidationRegex:
description: Password validation regular expression.
type: string
subject:
description: Certificate's subject
type: string
alternativeIpAddresses:
description: The list of alternative IP addresses.
type: array
items:
$ref: '#/definitions/AlternativeIpAddresses'
AlternativeDnsNames:
description: List of alternative DNS names.
type: string
AlternativeIpAddresses:
description: List of alternative IP Addresses.
type: string
SecretState:
description: Represents the secret state.
type: object
properties:
status:
description: The secret status.
$ref: '#/definitions/SecretStatus'
rotationStatus:
description: the secret rotation status.
$ref: '#/definitions/SecretRotationStatus'
expirationDate:
description: The secret expiration date.
type: string
format: date-time
SecretStatus:
description: Specifies the secret status.
type: string
enum:
- NotUploaded
- Uploaded
- Deployed
x-ms-enum:
modelAsString: true
name: SecretStatus
SecretRotationStatus:
description: Specifies the secret rotation status.
type: string
enum:
- None
- InProgress
- Complete
x-ms-enum:
modelAsString: true
name: SecretRotationStatus
value:
description: The secret value in a secure string format.
type: string
data:
description: The converted Base64 String from a certificate pfx file.
type: string
key:
description: The symmetric key as a secure string.
type: string
password:
description: The password as a secure string.
type: string
SecretParameters:
description: Parameters required for creating/updating a product secret.
type: object
properties:
value:
description: The secret value in a secure string format.
$ref: '#/definitions/value'
data:
description: The pfx certificate converted Base64 data.
$ref: '#/definitions/data'
password:
description: The pfx certificate file password.
$ref: '#/definitions/password'
key:
description: The symmetric key.
$ref: '#/definitions/key'
parameters:
SecretNameParameter:
description: The secret name.
name: secretName
in: path
required: true
type: string
x-ms-parameter-location: method
SecretParameters:
description: The parameters required for creating/updating a product secret.
name: secretParameters
in: body
required: true
schema:
$ref: '#/definitions/SecretParameters'
x-ms-parameter-location: method
SecretValueParameter:
description: The secret value in a secure string format.
name: secretValue
in: body
required: true
schema:
$ref: '#/definitions/value'
x-ms-parameter-location: method
securityDefinitions:
azure_auth:
type: oauth2
authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
flow: implicit
description: Authorization uses an Azure Active Directory OAuth2 flow.
scopes:
user_impersonation: impersonate your user account
security:
- azure_auth:
- user_impersonation
tags:
- name: ProductSecrets