Named Value - Create Or Update

참조

서비스:: API Management

API 버전:: 2024-05-01

명명된 값을 만들거나 업데이트합니다.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/namedValues/{namedValueId}?api-version=2024-05-01

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
namedValueId	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	NamedValue의 식별자입니다.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	리소스 그룹의 이름입니다. 이름은 대/소문자를 구분하지 않습니다.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management 서비스의 이름입니다.
subscriptionId	path	True	string (uuid)	대상 구독의 ID입니다. 값은 UUID여야 합니다.
api-version	query	True	string minLength: 1	이 작업에 사용할 API 버전입니다.

요청 헤더

Name	필수	형식	Description
If-Match		string	엔터티의 ETag입니다. 엔터티를 만들 때는 필요하지 않지만 엔터티를 업데이트할 때 필요합니다.

요청 본문

Name	필수	형식	Description
properties.displayName	True	string minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	NamedValue의 고유 이름입니다. 문자, 숫자, 마침표, 대시 및 밑줄 문자만 포함할 수 있습니다.
properties.keyVault		KeyVaultContractCreateProperties	namedValue의 KeyVault 위치 세부 정보입니다.
properties.secret		boolean	값이 비밀이고 암호화되어야 하는지 여부를 결정합니다. 기본값은 false입니다.
properties.tags		string[]	제공될 때 NamedValue 목록을 필터링하는 데 사용할 수 있는 선택적 태그입니다.
properties.value		string maxLength: 4096	NamedValue의 값입니다. 정책 식을 포함할 수 있습니다. 비어 있지 않거나 공백으로만 구성될 수 있습니다. 이 속성은 'GET' 작업에 채워지지 않습니다. '/listSecrets' POST 요청을 사용하여 값을 가져옵니다.

응답

Name	형식	Description
200 OK	NamedValueContract	명명된 값이 업데이트되었습니다. 헤더 ETag: string location: string Azure-AsyncOperation: string
201 Created	NamedValueContract	명명된 값이 성공적으로 생성되었습니다. 헤더 ETag: string location: string Azure-AsyncOperation: string
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

Name

형식

Description

200 OK

NamedValueContract

명명된 값이 업데이트되었습니다.

헤더

ETag: string
location: string
Azure-AsyncOperation: string

201 Created

NamedValueContract

명명된 값이 성공적으로 생성되었습니다.

헤더

ETag: string
location: string
Azure-AsyncOperation: string

Other Status Codes

ErrorResponse

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

형식: oauth2
Flow: implicit
권한 부여 URL: https://login.microsoftonline.com/common/oauth2/authorize

범위

Name	Description
user_impersonation	사용자 계정 가장

예제

ApiManagementCreateNamedValue

ApiManagementCreateNamedValueWithKeyVault

ApiManagementCreateNamedValue

샘플 요청

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-05-01

{
  "properties": {
    "displayName": "prop3name",
    "value": "propValue",
    "tags": [
      "foo",
      "bar"
    ],
    "secret": false
  }
}

샘플 응답

상태 코드:: 201

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-05-01

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2",
  "type": "Microsoft.ApiManagement/service/namedValues",
  "name": "testprop2",
  "properties": {
    "displayName": "prop3name",
    "value": "propValue",
    "tags": [
      "foo",
      "bar"
    ],
    "secret": false,
    "provisioningState": "InProgress"
  }
}

상태 코드:: 200

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=200
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-05-01

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop2",
  "type": "Microsoft.ApiManagement/service/namedValues",
  "name": "testprop2",
  "properties": {
    "displayName": "prop3name",
    "value": "propValue",
    "tags": [
      "foo",
      "bar"
    ],
    "secret": false,
    "provisioningState": "InProgress"
  }
}

ApiManagementCreateNamedValueWithKeyVault

샘플 요청

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2024-05-01

{
  "properties": {
    "displayName": "prop6namekv",
    "keyVault": {
      "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret"
    },
    "tags": [
      "foo",
      "bar"
    ],
    "secret": true
  }
}

샘플 응답

상태 코드:: 201

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=201
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-05-01

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6",
  "type": "Microsoft.ApiManagement/service/namedValues",
  "name": "testprop6",
  "properties": {
    "displayName": "prop6namekv",
    "keyVault": {
      "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret",
      "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "lastStatus": {
        "code": "Success",
        "timeStampUtc": "2020-09-11T00:54:31.8024882Z"
      }
    },
    "tags": [
      "foo",
      "bar"
    ],
    "secret": true,
    "provisioningState": "InProgress"
  }
}

상태 코드:: 200

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6?api-version=2024-05-01&asyncId=5c730e343244df1b9cb56e85&asyncCode=200
Azure-AsyncOperation: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5c730e343244df1b9cb56e85?api-version=2024-05-01

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/namedValues/testprop6",
  "type": "Microsoft.ApiManagement/service/namedValues",
  "name": "testprop6",
  "properties": {
    "displayName": "prop6namekv",
    "keyVault": {
      "secretIdentifier": "https://contoso.vault.azure.net/secrets/aadSecret",
      "identityClientId": "ceaa6b06-c00f-43ef-99ac-f53d1fe876a0",
      "lastStatus": {
        "code": "Success",
        "timeStampUtc": "2020-09-11T00:54:31.8024882Z"
      }
    },
    "tags": [
      "foo",
      "bar"
    ],
    "secret": true,
    "provisioningState": "InProgress"
  }
}

정의

Name	Description
ErrorAdditionalInfo	리소스 관리 오류 추가 정보입니다.
ErrorDetail	오류 세부 정보입니다.
ErrorResponse	오류 응답
KeyVaultContractCreateProperties	keyVault 계약 세부 정보를 만듭니다.
KeyVaultContractProperties	KeyVault 계약 세부 정보입니다.
KeyVaultLastAccessStatusContractProperties	계약 업데이트 속성을 발급합니다.
NamedValueContract	NamedValue 세부 정보입니다.
NamedValueCreateContract	NamedValue 세부 정보입니다.

ErrorAdditionalInfo

Object

리소스 관리 오류 추가 정보입니다.

Name	형식	Description
info	object	추가 정보입니다.
type	string	추가 정보 유형입니다.

ErrorDetail

Object

오류 세부 정보입니다.

Name	형식	Description
additionalInfo	ErrorAdditionalInfo[]	오류 추가 정보입니다.
code	string	오류 코드입니다.
details	ErrorDetail[]	오류 세부 정보입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

ErrorResponse

Object

오류 응답

Name	형식	Description
error	ErrorDetail	오류 개체입니다.

KeyVaultContractCreateProperties

Object

keyVault 계약 세부 정보를 만듭니다.

Name	형식	Description
identityClientId	string	Key Vault 비밀에 액세스하는 데 사용되는 UserAssignedIdentity의 경우 SystemAssignedIdentity 또는 클라이언트 ID의 경우 Null입니다.
secretIdentifier	string	비밀을 가져오기 위한 키 자격 증명 모음 비밀 식별자입니다. 버전이 지정된 비밀을 제공하면 자동 새로 고침이 방지됩니다. 이렇게 하려면 API Management 서비스를 aka.ms/apimmsi 사용하여 구성해야 합니다.

KeyVaultContractProperties

Object

KeyVault 계약 세부 정보입니다.

Name	형식	Description
identityClientId	string	Key Vault 비밀에 액세스하는 데 사용되는 UserAssignedIdentity의 경우 SystemAssignedIdentity 또는 클라이언트 ID의 경우 Null입니다.
lastStatus	KeyVaultLastAccessStatusContractProperties	키 자격 증명 모음에서 비밀의 마지막 동기화 및 새로 고침 상태입니다.
secretIdentifier	string	비밀을 가져오기 위한 키 자격 증명 모음 비밀 식별자입니다. 버전이 지정된 비밀을 제공하면 자동 새로 고침이 방지됩니다. 이렇게 하려면 API Management 서비스를 aka.ms/apimmsi 사용하여 구성해야 합니다.

KeyVaultLastAccessStatusContractProperties

Object

계약 업데이트 속성을 발급합니다.

Name	형식	Description
code	string	키 자격 증명 모음에서 비밀을 동기화하고 새로 고치는 마지막 상태 코드입니다.
message	string	오류에 대한 세부 정보는 비어 있습니다.
timeStampUtc	string (date-time)	마지막으로 비밀에 액세스했습니다. 날짜는 ISO 8601 표준에 지정된 `yyyy-MM-ddTHH:mm:ssZ` 형식을 준수합니다.

NamedValueContract

Object

NamedValue 세부 정보입니다.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	리소스의 이름
properties.displayName	string minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	NamedValue의 고유 이름입니다. 문자, 숫자, 마침표, 대시 및 밑줄 문자만 포함할 수 있습니다.
properties.keyVault	KeyVaultContractProperties	namedValue의 KeyVault 위치 세부 정보입니다.
properties.provisioningState	string	프로비저닝 상태
properties.secret	boolean	값이 비밀이고 암호화되어야 하는지 여부를 결정합니다. 기본값은 false입니다.
properties.tags	string[]	제공될 때 NamedValue 목록을 필터링하는 데 사용할 수 있는 선택적 태그입니다.
properties.value	string maxLength: 4096	NamedValue의 값입니다. 정책 식을 포함할 수 있습니다. 비어 있지 않거나 공백으로만 구성될 수 있습니다. 이 속성은 'GET' 작업에 채워지지 않습니다. '/listSecrets' POST 요청을 사용하여 값을 가져옵니다.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

NamedValueCreateContract

Object

NamedValue 세부 정보입니다.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	리소스의 이름
properties.displayName	string minLength: 1 maxLength: 256 pattern: ^[A-Za-z0-9-._]+$	NamedValue의 고유 이름입니다. 문자, 숫자, 마침표, 대시 및 밑줄 문자만 포함할 수 있습니다.
properties.keyVault	KeyVaultContractCreateProperties	namedValue의 KeyVault 위치 세부 정보입니다.
properties.secret	boolean	값이 비밀이고 암호화되어야 하는지 여부를 결정합니다. 기본값은 false입니다.
properties.tags	string[]	제공될 때 NamedValue 목록을 필터링하는 데 사용할 수 있는 선택적 태그입니다.
properties.value	string maxLength: 4096	NamedValue의 값입니다. 정책 식을 포함할 수 있습니다. 비어 있지 않거나 공백으로만 구성될 수 있습니다. 이 속성은 'GET' 작업에 채워지지 않습니다. '/listSecrets' POST 요청을 사용하여 값을 가져옵니다.
type	string	리소스의 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

다음을 통해 공유

Named Value - Create Or Update

URI 매개 변수

요청 헤더

요청 본문

응답

보안

azure_auth

범위

예제

ApiManagementCreateNamedValue

샘플 요청

샘플 응답

ApiManagementCreateNamedValueWithKeyVault

샘플 요청

샘플 응답

정의

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

KeyVaultContractCreateProperties

KeyVaultContractProperties

KeyVaultLastAccessStatusContractProperties

NamedValueContract

NamedValueCreateContract

추가 리소스