managedidentity.azure.com/v1api20230131

managedidentity.azure.com/v1api20230131

Package v1api20230131 contains API Schema definitions for the managedidentity v1api20230131 API group

Resource Types:

    APIVersion (string alias)

    Value Description

    "2023-01-31"

    FederatedIdentityCredential

    Generator information: - Generated from: /msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{resourceName}/​federatedIdentityCredentials/​{federatedIdentityCredentialResourceName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    UserAssignedIdentities_FederatedIdentityCredential_Spec


    audiences
    []string

    Audiences: The list of audiences that can appear in the issued token.

    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    issuer
    string

    Issuer: The URL of the issuer to be trusted.

    issuerFromConfig
    genruntime.ConfigMapReference

    IssuerFromConfig: The URL of the issuer to be trusted.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a managedidentity.azure.com/UserAssignedIdentity resource

    subject
    string

    Subject: The identifier of the external identity.

    subjectFromConfig
    genruntime.ConfigMapReference

    SubjectFromConfig: The identifier of the external identity.

    status
    UserAssignedIdentities_FederatedIdentityCredential_STATUS

    FederatedIdentityCredentialProperties_ARM

    (Appears on:UserAssignedIdentities_FederatedIdentityCredential_Spec_ARM)

    The properties associated with a federated identity credential.

    Field Description
    audiences
    []string

    Audiences: The list of audiences that can appear in the issued token.

    issuer
    string

    Issuer: The URL of the issuer to be trusted.

    subject
    string

    Subject: The identifier of the external identity.

    FederatedIdentityCredentialProperties_STATUS_ARM

    (Appears on:UserAssignedIdentities_FederatedIdentityCredential_STATUS_ARM)

    The properties associated with a federated identity credential.

    Field Description
    audiences
    []string

    Audiences: The list of audiences that can appear in the issued token.

    issuer
    string

    Issuer: The URL of the issuer to be trusted.

    subject
    string

    Subject: The identifier of the external identity.

    SystemData_CreatedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS, SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_LastModifiedByType_STATUS (string alias)

    (Appears on:SystemData_STATUS, SystemData_STATUS_ARM)

    Value Description

    "Application"

    "Key"

    "ManagedIdentity"

    "User"

    SystemData_STATUS

    (Appears on:UserAssignedIdentities_FederatedIdentityCredential_STATUS, UserAssignedIdentity_STATUS)

    Metadata pertaining to creation and last modification of the resource.

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).

    createdBy
    string

    CreatedBy: The identity that created the resource.

    createdByType
    SystemData_CreatedByType_STATUS

    CreatedByType: The type of identity that created the resource.

    lastModifiedAt
    string

    LastModifiedAt: The timestamp of resource last modification (UTC)

    lastModifiedBy
    string

    LastModifiedBy: The identity that last modified the resource.

    lastModifiedByType
    SystemData_LastModifiedByType_STATUS

    LastModifiedByType: The type of identity that last modified the resource.

    SystemData_STATUS_ARM

    (Appears on:UserAssignedIdentities_FederatedIdentityCredential_STATUS_ARM, UserAssignedIdentity_STATUS_ARM)

    Metadata pertaining to creation and last modification of the resource.

    Field Description
    createdAt
    string

    CreatedAt: The timestamp of resource creation (UTC).

    createdBy
    string

    CreatedBy: The identity that created the resource.

    createdByType
    SystemData_CreatedByType_STATUS

    CreatedByType: The type of identity that created the resource.

    lastModifiedAt
    string

    LastModifiedAt: The timestamp of resource last modification (UTC)

    lastModifiedBy
    string

    LastModifiedBy: The identity that last modified the resource.

    lastModifiedByType
    SystemData_LastModifiedByType_STATUS

    LastModifiedByType: The type of identity that last modified the resource.

    UserAssignedIdentities_FederatedIdentityCredential_STATUS

    (Appears on:FederatedIdentityCredential)

    Field Description
    audiences
    []string

    Audiences: The list of audiences that can appear in the issued token.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    id
    string

    Id: Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}”

    issuer
    string

    Issuer: The URL of the issuer to be trusted.

    name
    string

    Name: The name of the resource

    subject
    string

    Subject: The identifier of the external identity.

    systemData
    SystemData_STATUS

    SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    UserAssignedIdentities_FederatedIdentityCredential_STATUS_ARM

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}”

    name
    string

    Name: The name of the resource

    properties
    FederatedIdentityCredentialProperties_STATUS_ARM

    Properties: The properties associated with the federated identity credential.

    systemData
    SystemData_STATUS_ARM

    SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    UserAssignedIdentities_FederatedIdentityCredential_Spec

    (Appears on:FederatedIdentityCredential)

    Field Description
    audiences
    []string

    Audiences: The list of audiences that can appear in the issued token.

    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    issuer
    string

    Issuer: The URL of the issuer to be trusted.

    issuerFromConfig
    genruntime.ConfigMapReference

    IssuerFromConfig: The URL of the issuer to be trusted.

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a managedidentity.azure.com/UserAssignedIdentity resource

    subject
    string

    Subject: The identifier of the external identity.

    subjectFromConfig
    genruntime.ConfigMapReference

    SubjectFromConfig: The identifier of the external identity.

    UserAssignedIdentities_FederatedIdentityCredential_Spec_ARM

    Field Description
    name
    string
    properties
    FederatedIdentityCredentialProperties_ARM

    Properties: The properties associated with the federated identity credential.

    UserAssignedIdentity

    Generator information: - Generated from: /msi/resource-manager/Microsoft.ManagedIdentity/stable/2023-01-31/ManagedIdentity.json - ARM URI: /​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{resourceName}

    Field Description
    metadata
    Kubernetes meta/v1.ObjectMeta
    Refer to the Kubernetes API documentation for the fields of the metadata field.
    spec
    UserAssignedIdentity_Spec


    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    location
    string

    Location: The geo-location where the resource lives

    operatorSpec
    UserAssignedIdentityOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    tags
    map[string]string

    Tags: Resource tags.

    status
    UserAssignedIdentity_STATUS

    UserAssignedIdentityOperatorConfigMaps

    (Appears on:UserAssignedIdentityOperatorSpec)

    Field Description
    clientId
    genruntime.ConfigMapDestination

    ClientId: indicates where the ClientId config map should be placed. If omitted, no config map will be created.

    principalId
    genruntime.ConfigMapDestination

    PrincipalId: indicates where the PrincipalId config map should be placed. If omitted, no config map will be created.

    tenantId
    genruntime.ConfigMapDestination

    TenantId: indicates where the TenantId config map should be placed. If omitted, no config map will be created.

    UserAssignedIdentityOperatorSecrets

    (Appears on:UserAssignedIdentityOperatorSpec)

    Field Description
    clientId
    genruntime.SecretDestination

    ClientId: indicates where the ClientId secret should be placed. If omitted, the secret will not be retrieved from Azure.

    principalId
    genruntime.SecretDestination

    PrincipalId: indicates where the PrincipalId secret should be placed. If omitted, the secret will not be retrieved from Azure.

    tenantId
    genruntime.SecretDestination

    TenantId: indicates where the TenantId secret should be placed. If omitted, the secret will not be retrieved from Azure.

    UserAssignedIdentityOperatorSpec

    (Appears on:UserAssignedIdentity_Spec)

    Details for configuring operator behavior. Fields in this struct are interpreted by the operator directly rather than being passed to Azure

    Field Description
    configMaps
    UserAssignedIdentityOperatorConfigMaps

    ConfigMaps: configures where to place operator written ConfigMaps.

    secrets
    UserAssignedIdentityOperatorSecrets

    Secrets: configures where to place Azure generated secrets.

    UserAssignedIdentityProperties_STATUS_ARM

    (Appears on:UserAssignedIdentity_STATUS_ARM)

    The properties associated with the user assigned identity.

    Field Description
    clientId
    string

    ClientId: The id of the app associated with the identity. This is a random generated UUID by MSI.

    principalId
    string

    PrincipalId: The id of the service principal object associated with the created identity.

    tenantId
    string

    TenantId: The id of the tenant which the identity belongs to.

    UserAssignedIdentity_STATUS

    (Appears on:UserAssignedIdentity)

    Field Description
    clientId
    string

    ClientId: The id of the app associated with the identity. This is a random generated UUID by MSI.

    conditions
    []genruntime/conditions.Condition

    Conditions: The observed state of the resource

    id
    string

    Id: Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}”

    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the resource

    principalId
    string

    PrincipalId: The id of the service principal object associated with the created identity.

    systemData
    SystemData_STATUS

    SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

    tags
    map[string]string

    Tags: Resource tags.

    tenantId
    string

    TenantId: The id of the tenant which the identity belongs to.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    UserAssignedIdentity_STATUS_ARM

    Field Description
    id
    string

    Id: Fully qualified resource ID for the resource. E.g. “/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​{resourceProviderNamespace}/​{resourceType}/​{resourceName}”

    location
    string

    Location: The geo-location where the resource lives

    name
    string

    Name: The name of the resource

    properties
    UserAssignedIdentityProperties_STATUS_ARM

    Properties: The properties associated with the identity.

    systemData
    SystemData_STATUS_ARM

    SystemData: Azure Resource Manager metadata containing createdBy and modifiedBy information.

    tags
    map[string]string

    Tags: Resource tags.

    type
    string

    Type: The type of the resource. E.g. “Microsoft.Compute/virtualMachines” or “Microsoft.Storage/storageAccounts”

    UserAssignedIdentity_Spec

    (Appears on:UserAssignedIdentity)

    Field Description
    azureName
    string

    AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

    location
    string

    Location: The geo-location where the resource lives

    operatorSpec
    UserAssignedIdentityOperatorSpec

    OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure

    owner
    genruntime.KnownResourceReference

    Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

    tags
    map[string]string

    Tags: Resource tags.

    UserAssignedIdentity_Spec_ARM

    Field Description
    location
    string

    Location: The geo-location where the resource lives

    name
    string
    tags
    map[string]string

    Tags: Resource tags.