Шаги Microsoft.DeploymentManager

Статья
07/20/2023

Определение ресурса Bicep

Тип ресурса steps можно развернуть в:

Группы ресурсов — см. команды развертывания группы ресурсов.

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.DeploymentManager/steps, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.DeploymentManager/steps@2019-11-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    stepType: 'string'
    // For remaining properties, see StepProperties objects
  }
}

Объекты StepProperties

Задайте свойство stepType , чтобы указать тип объекта .

Для HealthCheck используйте:

  stepType: 'HealthCheck'
  attributes: {
    healthyStateDuration: 'string'
    maxElasticDuration: 'string'
    waitDuration: 'string'
    type: 'string'
    // For remaining properties, see HealthCheckStepAttributes objects
  }

Для параметра Wait используйте:

  stepType: 'Wait'
  attributes: {
    duration: 'string'
  }

Объекты HealthCheckStepAttributes

Задайте свойство type , чтобы указать тип объекта .

Для REST используйте:

  type: 'REST'
  properties: {
    healthChecks: [
      {
        name: 'string'
        request: {
          authentication: {
            type: 'string'
            // For remaining properties, see RestRequestAuthentication objects
          }
          method: 'string'
          uri: 'string'
        }
        response: {
          regex: {
            matches: [
              'string'
            ]
            matchQuantifier: 'string'
          }
          successStatusCodes: [
            'string'
          ]
        }
      }
    ]
  }

Объекты RestRequestAuthentication

Задайте свойство type , чтобы указать тип объекта .

Для ApiKey используйте:

  type: 'ApiKey'
  in: 'string'
  name: 'string'
  value: 'string'

Для RolloutIdentity используйте:

  type: 'RolloutIdentity'

Значения свойств

steps

Имя	Описание	Значение
name	имя ресурса.	строка (обязательно)
location	Географическое расположение, в котором находится ресурс	строка (обязательно)
tags	Теги ресурсов.	Словарь имен и значений тегов. См . раздел Теги в шаблонах
properties	Свойства, определяющие шаг.	StepProperties (обязательно)

Свойства StepProperties

Имя	Описание	Значение
stepType	Установка типа объекта	Проверка работоспособности Ожидание (обязательно)

HealthCheckStepProperties

Имя	Описание	Значение
stepType	Тип шага.	HealthCheck (обязательно)
attributes	Атрибуты шага проверки работоспособности	HealthCheckStepAttributes (обязательно)

HealthCheckStepAttributes

Имя	Описание	Значение
healthyStateDuration	Длительность в формате ISO 8601, в течение которой ожидается постоянная работоспособность ресурса. Если указано значение maxElasticDuration, то длительность работоспособного состояния применяется после обнаружения первого сигнала работоспособности.	строка (обязательно)
maxElasticDuration	Длительность в формате ISO 8601, в течение которой проверка работоспособности ожидает, пока ресурс станет работоспособным. Проверка работоспособности завершается ошибкой, если она не выполняется. Проверка работоспособности начинает применять healthyStateDuration после того, как ресурс становится работоспособным.	строка
waitDuration	Продолжительность в формате ISO 8601, для которой проверка работоспособности ожидает без проверки.	строка
type	Установка типа объекта	REST (обязательно)

RestHealthCheckStepAttributes

Имя	Описание	Значение
тип	Тип проверки работоспособности.	REST (обязательно)
properties	Параметры проверки работоспособности REST.	Параметры RestParameters

Параметры RestParameters

Имя	Описание	Значение
healthChecks	Список проверок, образующих этап проверки работоспособности.	RestHealthCheck[] (обязательно)

RestHealthCheck

Имя	Описание	Значение
name	Уникальное имя для этой проверки.	string (обязательно)
запрос	Запрос к поставщику работоспособности.	RestRequest (обязательно)
Ответ	Ожидаемый ответ от поставщика работоспособности. Если ожидаемый ответ не указан, по умолчанию ожидается, что полученный ответ будет иметь код состояния HTTP 200 OK.	RestResponse

RestRequest

Имя	Описание	Значение
проверка подлинности	Сведения о проверке подлинности, необходимые в запросе к поставщику работоспособности.	RestRequestAuthentication (обязательно)
method	Метод HTTP, используемый для запроса.	"GET" "POST" (обязательно)
uri	Универсальный код ресурса (URI) HTTP, используемый для запроса.	string (обязательно)

RestRequestAuthentication

Имя	Описание	Значение
тип	Установка типа объекта	ApiKey RolloutIdentity (обязательно)

ApiKeyAuthentication

Имя	Описание	Значение
тип	Тип проверки подлинности.	ApiKey (обязательно)
in	Расположение пары "ключ-значение" проверки подлинности в запросе.	"Заголовок" "Запрос" (обязательно)
name	Имя ключа пары "ключ—значение" проверки подлинности.	string (обязательно)
значение	Значение пары "ключ-значение" проверки подлинности.	string (обязательно)

RolloutIdentityAuthentication

Имя	Описание	Значение
тип	Тип проверки подлинности.	RolloutIdentity (обязательно)

RestResponse

Имя	Описание	Значение
regex	Регулярные выражения для сопоставления содержимого ответа.	RestResponseRegex
successStatusCodes	Коды состояния HTTP, ожидаемые в успешном ответе проверки работоспособности. Ожидается, что ответ будет соответствовать одному из заданных кодов состояния. Если ожидаемые коды состояния не указаны, ожидаемый код состояния по умолчанию — 200 OK.	string[]

RestResponseRegex

Имя	Описание	Значение
соответствия	Список регулярных выражений.	string[]
matchQuantifier	Указывает, должно ли любое или все выражения совпадать с содержимым ответа.	"Все" "Любой"

WaitStepProperties

Имя	Описание	Значение
stepType	Тип шага.	Wait (обязательно)
attributes	Атрибуты wait	WaitStepAttributes (обязательно)

WaitStepAttributes

Имя	Описание	Значение
длительность	Длительность ожидания в формате ISO 8601.	string (обязательно)

Определение ресурса шаблона ARM

Тип ресурса steps можно развернуть в следующих объектах:

Группы ресурсов — см. команды развертывания групп ресурсов.

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.DeploymentManager/steps, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.DeploymentManager/steps",
  "apiVersion": "2019-11-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "stepType": "string"
    // For remaining properties, see StepProperties objects
  }
}

Объекты StepProperties

Задайте свойство stepType , чтобы указать тип объекта .

Для HealthCheck используйте:

  "stepType": "HealthCheck",
  "attributes": {
    "healthyStateDuration": "string",
    "maxElasticDuration": "string",
    "waitDuration": "string",
    "type": "string"
    // For remaining properties, see HealthCheckStepAttributes objects
  }

Для параметра Ожидание используйте:

  "stepType": "Wait",
  "attributes": {
    "duration": "string"
  }

Объекты HealthCheckStepAttributes

Задайте свойство type , чтобы указать тип объекта .

Для REST используйте:

  "type": "REST",
  "properties": {
    "healthChecks": [
      {
        "name": "string",
        "request": {
          "authentication": {
            "type": "string"
            // For remaining properties, see RestRequestAuthentication objects
          },
          "method": "string",
          "uri": "string"
        },
        "response": {
          "regex": {
            "matches": [ "string" ],
            "matchQuantifier": "string"
          },
          "successStatusCodes": [ "string" ]
        }
      }
    ]
  }

Объекты RestRequestAuthentication

Задайте свойство type , чтобы указать тип объекта .

Для ApiKey используйте:

  "type": "ApiKey",
  "in": "string",
  "name": "string",
  "value": "string"

Для параметра RolloutIdentity используйте:

  "type": "RolloutIdentity"

Значения свойств

steps

Имя	Описание	Значение
тип	Тип ресурса	Microsoft.DeploymentManager/steps
версия_API	Версия API ресурсов	'2019-11-01-preview'
name	имя ресурса.	string (обязательно)
location	Географическое расположение, в котором находится ресурс	string (обязательно)
tags	Теги ресурсов.	Словарь имен и значений тегов. См . раздел Теги в шаблонах
properties	Свойства, определяющие шаг.	StepProperties (обязательно)

Свойства StepProperties

Имя	Описание	Значение
stepType	Установка типа объекта	Проверка работоспособности Ожидание (обязательно)

HealthCheckStepProperties

Имя	Описание	Значение
stepType	Тип шага.	HealthCheck (обязательно)
attributes	Атрибуты шага проверки работоспособности	HealthCheckStepAttributes (обязательно)

HealthCheckStepAttributes

Имя	Описание	Значение
healthyStateDuration	Длительность в формате ISO 8601, в течение которой ожидается непрерывное работоспособное состояние ресурса. Если указан параметр maxElasticDuration, то после обнаружения первого сигнала работоспособности применяется длительность работоспособного состояния.	string (обязательно)
maxElasticDuration	Длительность в формате ISO 8601, в течение которой проверка работоспособности ожидает работоспособности ресурса. Проверка работоспособности завершается ошибкой, если это не так. Проверка работоспособности начинает применять healthStateDuration после того, как ресурс становится работоспособным.	строка
waitDuration	Длительность в формате ISO 8601, для которой проверка работоспособности ожидается без каких-либо проверок.	строка
type	Установка типа объекта	REST (обязательно)

RestHealthCheckStepAttributes

Имя	Описание	Значение
тип	Тип проверки работоспособности.	REST (обязательно)
properties	Параметры проверки работоспособности REST.	RestParameters

RestParameters

Имя	Описание	Значение
HealthChecks	Список проверок, образующих шаг проверки работоспособности.	RestHealthCheck[] (обязательно)

RestHealthCheck

Имя	Описание	Значение
name	Уникальное имя для этой проверки.	string (обязательно)
запрос	Запрос к поставщику работоспособности.	RestRequest (обязательно)
Ответ	Ожидаемый ответ от поставщика работоспособности. Если ожидаемый ответ не указан, по умолчанию ожидается, что полученный ответ будет иметь код состояния HTTP 200 OK.	RestResponse

RestRequest

Имя	Описание	Значение
проверка подлинности	Сведения о проверке подлинности, необходимые в запросе к поставщику работоспособности.	RestRequestAuthentication (обязательно)
method	Метод HTTP, используемый для запроса.	"GET" "POST" (обязательно)
uri	Универсальный код ресурса (URI) HTTP, используемый для запроса.	string (обязательно)

RestRequestAuthentication

Имя	Описание	Значение
тип	Установка типа объекта	ApiKey RolloutIdentity (обязательно)

ApiKeyAuthentication

Имя	Описание	Значение
тип	Тип проверки подлинности.	ApiKey (обязательно)
in	Расположение пары "ключ-значение" проверки подлинности в запросе.	"Заголовок" "Запрос" (обязательно)
name	Имя ключа пары "ключ—значение" проверки подлинности.	string (обязательно)
значение	Значение пары "ключ-значение" проверки подлинности.	string (обязательно)

RolloutIdentityAuthentication

Имя	Описание	Значение
тип	Тип проверки подлинности.	RolloutIdentity (обязательно)

RestResponse

Имя	Описание	Значение
regex	Регулярные выражения для сопоставления содержимого ответа.	RestResponseRegex
successStatusCodes	Коды состояния HTTP, ожидаемые в успешном ответе проверки работоспособности. Ожидается, что ответ будет соответствовать одному из заданных кодов состояния. Если ожидаемые коды состояния не указаны, ожидаемый код состояния по умолчанию — 200 OK.	string[]

RestResponseRegex

Имя	Описание	Значение
соответствия	Список регулярных выражений.	string[]
matchQuantifier	Указывает, должно ли любое или все выражения совпадать с содержимым ответа.	"Все" "Любой"

WaitStepProperties

Имя	Описание	Значение
stepType	Тип шага.	Wait (обязательно)
attributes	Атрибуты wait	WaitStepAttributes (обязательно)

WaitStepAttributes

Имя	Описание	Значение
длительность	Длительность ожидания в формате ISO 8601.	string (обязательно)

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса steps можно развернуть в следующих объектах:

Группы ресурсов

Список измененных свойств в каждой версии API см. в журнале изменений.

Формат ресурсов

Чтобы создать ресурс Microsoft.DeploymentManager/steps, добавьте следующую terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DeploymentManager/steps@2019-11-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      stepType = "string"
      // For remaining properties, see StepProperties objects
    }
  })
}

Объекты StepProperties

Задайте свойство stepType , чтобы указать тип объекта .

Для HealthCheck используйте:

  stepType = "HealthCheck"
  attributes = {
    healthyStateDuration = "string"
    maxElasticDuration = "string"
    waitDuration = "string"
    type = "string"
    // For remaining properties, see HealthCheckStepAttributes objects
  }

Для параметра Wait используйте:

  stepType = "Wait"
  attributes = {
    duration = "string"
  }

Объекты HealthCheckStepAttributes

Задайте свойство type , чтобы указать тип объекта .

Для REST используйте:

  type = "REST"
  properties = {
    healthChecks = [
      {
        name = "string"
        request = {
          authentication = {
            type = "string"
            // For remaining properties, see RestRequestAuthentication objects
          }
          method = "string"
          uri = "string"
        }
        response = {
          regex = {
            matches = [
              "string"
            ]
            matchQuantifier = "string"
          }
          successStatusCodes = [
            "string"
          ]
        }
      }
    ]
  }

Объекты RestRequestAuthentication

Задайте свойство type , чтобы указать тип объекта .

Для ApiKey используйте:

  type = "ApiKey"
  in = "string"
  name = "string"
  value = "string"

Для RolloutIdentity используйте:

  type = "RolloutIdentity"

Значения свойств

steps

Имя	Описание	Значение
тип	Тип ресурса	"Microsoft.DeploymentManager/steps@2019-11-01-preview"
name	имя ресурса.	строка (обязательно)
location	Географическое расположение, в котором находится ресурс	строка (обязательно)
parent_id	Чтобы выполнить развертывание в группе ресурсов, используйте идентификатор этой группы ресурсов.	строка (обязательно)
tags	Теги ресурсов.	Словарь имен и значений тегов.
properties	Свойства, определяющие шаг.	StepProperties (обязательно)

Свойства StepProperties

Имя	Описание	Значение
stepType	Установка типа объекта	Проверка работоспособности Ожидание (обязательно)

HealthCheckStepProperties

Имя	Описание	Значение
stepType	Тип шага.	HealthCheck (обязательно)
attributes	Атрибуты шага проверки работоспособности	HealthCheckStepAttributes (обязательно)

HealthCheckStepAttributes

Имя	Описание	Значение
healthyStateDuration	Длительность в формате ISO 8601, в течение которой ожидается постоянная работоспособность ресурса. Если указано значение maxElasticDuration, то длительность работоспособного состояния применяется после обнаружения первого сигнала работоспособности.	строка (обязательно)
maxElasticDuration	Длительность в формате ISO 8601, в течение которой проверка работоспособности ожидает, пока ресурс станет работоспособным. Проверка работоспособности завершается ошибкой, если она не выполняется. Проверка работоспособности начинает применять healthyStateDuration после того, как ресурс становится работоспособным.	строка
waitDuration	Продолжительность в формате ISO 8601, для которой проверка работоспособности ожидает без проверки.	строка
type	Установка типа объекта	REST (обязательно)

RestHealthCheckStepAttributes

Имя	Описание	Значение
тип	Тип проверки работоспособности.	REST (обязательно)
properties	Параметры проверки работоспособности REST.	Параметры RestParameters

Параметры RestParameters

Имя	Описание	Значение
healthChecks	Список проверок, образующих этап проверки работоспособности.	RestHealthCheck[] (обязательно)

RestHealthCheck

Имя	Описание	Значение
name	Уникальное имя для этой проверки.	строка (обязательно)
запрос	Запрос к поставщику работоспособности.	RestRequest (обязательно)
Ответ	Ожидаемый ответ от поставщика работоспособности. Если ожидаемый ответ не указан, по умолчанию ожидается, что полученный ответ будет иметь код состояния HTTP 200 OK.	RestResponse

RestRequest

Имя	Описание	Значение
проверка подлинности	Сведения о проверке подлинности, необходимые в запросе к поставщику работоспособности.	RestRequestAuthentication (обязательно)
method	Метод HTTP, используемый для запроса.	"GET" "POST" (обязательно)
uri	Универсальный код ресурса (URI) HTTP, используемый для запроса.	string (обязательно)

RestRequestAuthentication

Имя	Описание	Значение
тип	Установка типа объекта	ApiKey RolloutIdentity (обязательно)

ApiKeyAuthentication

Имя	Описание	Значение
тип	Тип проверки подлинности.	ApiKey (обязательно)
in	Расположение пары "ключ-значение" проверки подлинности в запросе.	Заголовок "Запрос" (обязательно)
name	Имя ключа пары "ключ—значение" проверки подлинности.	string (обязательно)
значение	Значение пары "ключ-значение" проверки подлинности.	string (обязательно)

RolloutIdentityAuthentication

Имя	Описание	Значение
тип	Тип проверки подлинности.	"RolloutIdentity" (обязательно)

RestResponse

Имя	Описание	Значение
regex	Регулярные выражения для сопоставления содержимого ответа.	RestResponseRegex
successStatusCodes	Коды состояния HTTP, ожидаемые в успешном ответе проверки работоспособности. Ожидается, что ответ будет соответствовать одному из заданных кодов состояния. Если ожидаемые коды состояния не указаны, ожидаемый код состояния по умолчанию — 200 OK.	string[]

RestResponseRegex

Имя	Описание	Значение
соответствия	Список регулярных выражений.	string[]
matchQuantifier	Указывает, должно ли любое или все выражения совпадать с содержимым ответа.	"All" "Любой"

WaitStepProperties

Имя	Описание	Значение
stepType	Тип шага.	"Ожидание" (обязательно)
attributes	Атрибуты wait	WaitStepAttributes (обязательно)

WaitStepAttributes

Имя	Описание	Значение
длительность	Длительность ожидания в формате ISO 8601.	string (обязательно)

Шаги Microsoft.DeploymentManager

Определение ресурса Bicep

Формат ресурсов

Объекты StepProperties

Объекты HealthCheckStepAttributes

Объекты RestRequestAuthentication

Значения свойств

steps

Свойства StepProperties

HealthCheckStepProperties

HealthCheckStepAttributes

RestHealthCheckStepAttributes

Параметры RestParameters

RestHealthCheck

RestRequest

RestRequestAuthentication

ApiKeyAuthentication

RolloutIdentityAuthentication

RestResponse

RestResponseRegex

WaitStepProperties

WaitStepAttributes

Определение ресурса шаблона ARM

Формат ресурсов

Объекты StepProperties

Объекты HealthCheckStepAttributes

Объекты RestRequestAuthentication

Значения свойств

steps

Свойства StepProperties

HealthCheckStepProperties

HealthCheckStepAttributes

RestHealthCheckStepAttributes

RestParameters

RestHealthCheck

RestRequest

RestRequestAuthentication

ApiKeyAuthentication

RolloutIdentityAuthentication

RestResponse

RestResponseRegex

WaitStepProperties

WaitStepAttributes

Определение ресурса Terraform (поставщик AzAPI)

Формат ресурсов

Объекты StepProperties

Объекты HealthCheckStepAttributes

Объекты RestRequestAuthentication

Значения свойств

steps

Свойства StepProperties

HealthCheckStepProperties

HealthCheckStepAttributes

RestHealthCheckStepAttributes

Параметры RestParameters

RestHealthCheck

RestRequest

RestRequestAuthentication

ApiKeyAuthentication

RolloutIdentityAuthentication

RestResponse

RestResponseRegex

WaitStepProperties

WaitStepAttributes

Обратная связь

Обратная связь

Дополнительные ресурсы