다음을 통해 공유


Microsoft.ApiManagement 서비스/작업 영역/namedValues 2024-05-01

Bicep 리소스 정의

다음을 대상으로 하는 작업으로 서비스/작업 영역/namedValues 리소스 유형을 배포할 수 있습니다.

각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.

리소스 형식

Microsoft.ApiManagement/service/workspaces/namedValues 리소스를 만들려면 템플릿에 다음 Bicep을 추가합니다.

resource symbolicname 'Microsoft.ApiManagement/service/workspaces/namedValues@2024-05-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    displayName: 'string'
    keyVault: {
      identityClientId: 'string'
      secretIdentifier: 'string'
    }
    secret: bool
    tags: [
      'string'
    ]
    value: 'string'
  }
}

속성 값

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

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

Microsoft.ApiManagement/service/workspaces/namedValues

이름 묘사
이름 리소스 이름 문자열

제약 조건:
최대 길이 = 256
패턴 = ^[^*#&+:<>?]+$(필수)
부모 Bicep에서 자식 리소스에 대한 부모 리소스를 지정할 수 있습니다. 자식 리소스가 부모 리소스 외부에서 선언된 경우에만 이 속성을 추가해야 합니다.

자세한 내용은 부모 리소스외부의 자식 리소스 참조하세요.
형식 리소스의 기호 이름: 서비스/작업 영역
속성 PUT 작업에 대한 NamedValue 엔터티 계약 속성입니다. NamedValueCreateContractPropertiesOrNamedValueContractProperties

NamedValueCreateContractPropertiesOrNamedValueContractProperties

이름 묘사
displayName NamedValue의 고유 이름입니다. 문자, 숫자, 마침표, 대시 및 밑줄 문자만 포함할 수 있습니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 256
패턴 = ^[A-Za-z0-9-._]+$(필수)
keyVault namedValue의 KeyVault 위치 세부 정보입니다. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
비밀 값이 비밀이고 암호화되어야 하는지 여부를 결정합니다. 기본값은 false입니다. bool
태그 제공될 때 NamedValue 목록을 필터링하는 데 사용할 수 있는 선택적 태그입니다. string[]
NamedValue의 값입니다. 정책 식을 포함할 수 있습니다. 비어 있지 않거나 공백으로만 구성될 수 있습니다. 이 속성은 'GET' 작업에 채워지지 않습니다. '/listSecrets' POST 요청을 사용하여 값을 가져옵니다. 문자열

제약 조건:
최대 길이 = 4096

ARM 템플릿 리소스 정의

다음을 대상으로 하는 작업으로 서비스/작업 영역/namedValues 리소스 유형을 배포할 수 있습니다.

각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.

리소스 형식

Microsoft.ApiManagement/service/workspaces/namedValues 리소스를 만들려면 템플릿에 다음 JSON을 추가합니다.

{
  "type": "Microsoft.ApiManagement/service/workspaces/namedValues",
  "apiVersion": "2024-05-01",
  "name": "string",
  "properties": {
    "displayName": "string",
    "keyVault": {
      "identityClientId": "string",
      "secretIdentifier": "string"
    },
    "secret": "bool",
    "tags": [ "string" ],
    "value": "string"
  }
}

속성 값

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

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

Microsoft.ApiManagement/service/workspaces/namedValues

이름 묘사
apiVersion api 버전 '2024-05-01'
이름 리소스 이름 문자열

제약 조건:
최대 길이 = 256
패턴 = ^[^*#&+:<>?]+$(필수)
속성 PUT 작업에 대한 NamedValue 엔터티 계약 속성입니다. NamedValueCreateContractPropertiesOrNamedValueContractProperties
리소스 종류 'Microsoft.ApiManagement/service/workspaces/namedValues'

NamedValueCreateContractPropertiesOrNamedValueContractProperties

이름 묘사
displayName NamedValue의 고유 이름입니다. 문자, 숫자, 마침표, 대시 및 밑줄 문자만 포함할 수 있습니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 256
패턴 = ^[A-Za-z0-9-._]+$(필수)
keyVault namedValue의 KeyVault 위치 세부 정보입니다. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
비밀 값이 비밀이고 암호화되어야 하는지 여부를 결정합니다. 기본값은 false입니다. bool
태그 제공될 때 NamedValue 목록을 필터링하는 데 사용할 수 있는 선택적 태그입니다. string[]
NamedValue의 값입니다. 정책 식을 포함할 수 있습니다. 비어 있지 않거나 공백으로만 구성될 수 있습니다. 이 속성은 'GET' 작업에 채워지지 않습니다. '/listSecrets' POST 요청을 사용하여 값을 가져옵니다. 문자열

제약 조건:
최대 길이 = 4096

Terraform(AzAPI 공급자) 리소스 정의

다음을 대상으로 하는 작업으로 서비스/작업 영역/namedValues 리소스 유형을 배포할 수 있습니다.

  • 리소스 그룹

각 API 버전에서 변경된 속성 목록은 변경 로그참조하세요.

리소스 형식

Microsoft.ApiManagement/service/workspaces/namedValues 리소스를 만들려면 템플릿에 다음 Terraform을 추가합니다.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/workspaces/namedValues@2024-05-01"
  name = "string"
  body = jsonencode({
    properties = {
      displayName = "string"
      keyVault = {
        identityClientId = "string"
        secretIdentifier = "string"
      }
      secret = bool
      tags = [
        "string"
      ]
      value = "string"
    }
  })
}

속성 값

KeyVaultContractCreatePropertiesOrKeyVaultContractProperties

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

Microsoft.ApiManagement/service/workspaces/namedValues

이름 묘사
이름 리소스 이름 문자열

제약 조건:
최대 길이 = 256
패턴 = ^[^*#&+:<>?]+$(필수)
parent_id 이 리소스의 부모인 리소스의 ID입니다. 형식의 리소스 ID: 서비스/작업 영역
속성 PUT 작업에 대한 NamedValue 엔터티 계약 속성입니다. NamedValueCreateContractPropertiesOrNamedValueContractProperties
리소스 종류 "Microsoft.ApiManagement/service/workspaces/namedValues@2024-05-01"

NamedValueCreateContractPropertiesOrNamedValueContractProperties

이름 묘사
displayName NamedValue의 고유 이름입니다. 문자, 숫자, 마침표, 대시 및 밑줄 문자만 포함할 수 있습니다. 문자열

제약 조건:
최소 길이 = 1
최대 길이 = 256
패턴 = ^[A-Za-z0-9-._]+$(필수)
keyVault namedValue의 KeyVault 위치 세부 정보입니다. KeyVaultContractCreatePropertiesOrKeyVaultContractProperties
비밀 값이 비밀이고 암호화되어야 하는지 여부를 결정합니다. 기본값은 false입니다. bool
태그 제공될 때 NamedValue 목록을 필터링하는 데 사용할 수 있는 선택적 태그입니다. string[]
NamedValue의 값입니다. 정책 식을 포함할 수 있습니다. 비어 있지 않거나 공백으로만 구성될 수 있습니다. 이 속성은 'GET' 작업에 채워지지 않습니다. '/listSecrets' POST 요청을 사용하여 값을 가져옵니다. 문자열

제약 조건:
최대 길이 = 4096